1 # Copyright 1992-2020 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
32 load_lib check-test-names.exp
36 # The spawn ID used for I/O interaction with the inferior. For native
37 # targets, or remote targets that can do I/O through GDB
38 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
39 # Otherwise, the board may set this to some other spawn ID. E.g.,
40 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
41 # so input/output is done on gdbserver's tty.
42 global inferior_spawn_id
44 if [info exists TOOL_EXECUTABLE] {
45 set GDB $TOOL_EXECUTABLE
47 if ![info exists GDB] {
48 if ![is_remote host] {
49 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
51 set GDB [transform gdb]
54 verbose "using GDB = $GDB" 2
56 # GDBFLAGS is available for the user to set on the command line.
57 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
58 # Testcases may use it to add additional flags, but they must:
59 # - append new flags, not overwrite
60 # - restore the original value when done
62 if ![info exists GDBFLAGS] {
65 verbose "using GDBFLAGS = $GDBFLAGS" 2
67 # Make the build data directory available to tests.
68 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
70 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
71 global INTERNAL_GDBFLAGS
72 if ![info exists INTERNAL_GDBFLAGS] {
73 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
76 # The variable gdb_prompt is a regexp which matches the gdb prompt.
77 # Set it if it is not already set. This is also set by default_gdb_init
78 # but it's not clear what removing one of them will break.
79 # See with_gdb_prompt for more details on prompt handling.
81 if ![info exists gdb_prompt] then {
82 set gdb_prompt "\\(gdb\\)"
85 # A regexp that matches the pagination prompt.
86 set pagination_prompt \
87 "--Type <RET> for more, q to quit, c to continue without paging--"
89 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
90 # absolute path ie. /foo/
91 set fullname_syntax_POSIX {/[^\n]*/}
92 # The variable fullname_syntax_UNC is a regexp which matches a Windows
93 # UNC path ie. \\D\foo\
94 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
95 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
96 # particular DOS case that GDB most likely will output
97 # ie. \foo\, but don't match \\.*\
98 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
99 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
100 # ie. a:\foo\ && a:foo\
101 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
102 # The variable fullname_syntax is a regexp which matches what GDB considers
103 # an absolute path. It is currently debatable if the Windows style paths
104 # d:foo and \abc should be considered valid as an absolute path.
105 # Also, the purpse of this regexp is not to recognize a well formed
106 # absolute path, but to say with certainty that a path is absolute.
107 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
109 # Needed for some tests under Cygwin.
113 if ![info exists env(EXEEXT)] {
116 set EXEEXT $env(EXEEXT)
121 set inferior_exited_re "(?:\\\[Inferior \[0-9\]+ \\(\[^\n\r\]*\\) exited)"
123 # A regular expression that matches a value history number.
125 set valnum_re "\\\$$decimal"
127 ### Only procedures should come after this point.
130 # gdb_version -- extract and print the version number of GDB
132 proc default_gdb_version {} {
134 global INTERNAL_GDBFLAGS GDBFLAGS
138 if {[info exists inotify_pid]} {
139 eval exec kill $inotify_pid
142 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
143 set tmp [lindex $output 1]
145 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
146 if ![is_remote host] {
147 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
149 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
153 proc gdb_version { } {
154 return [default_gdb_version]
158 # gdb_unload -- unload a file if one is loaded
159 # Return 0 on success, -1 on error.
167 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
168 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
169 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
170 send_gdb "y\n" answer
173 -re "Discard symbol table from .*y or n.*$" {
174 send_gdb "y\n" answer
177 -re "$gdb_prompt $" {}
179 perror "couldn't unload file in $GDB (timeout)."
186 # Many of the tests depend on setting breakpoints at various places and
187 # running until that breakpoint is reached. At times, we want to start
188 # with a clean-slate with respect to breakpoints, so this utility proc
189 # lets us do this without duplicating this code everywhere.
192 proc delete_breakpoints {} {
195 # we need a larger timeout value here or this thing just confuses
196 # itself. May need a better implementation if possible. - guo
200 set msg "delete all breakpoints in delete_breakpoints"
202 gdb_test_multiple "delete breakpoints" "$msg" {
203 -re "Delete all breakpoints.*y or n.*$" {
204 send_gdb "y\n" answer
207 -re "$gdb_prompt $" {
213 # Confirm with "info breakpoints".
215 set msg "info breakpoints"
216 gdb_test_multiple $msg $msg {
217 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
220 -re "$gdb_prompt $" {
226 perror "breakpoints not deleted"
230 # Returns true iff the target supports using the "run" command.
232 proc target_can_use_run_cmd {} {
233 if [target_info exists use_gdb_stub] {
234 # In this case, when we connect, the inferior is already
243 # Generic run command.
245 # Return 0 if we could start the program, -1 if we could not.
247 # The second pattern below matches up to the first newline *only*.
248 # Using ``.*$'' could swallow up output that we attempt to match
251 # INFERIOR_ARGS is passed as arguments to the start command, so may contain
252 # inferior arguments.
254 # N.B. This function does not wait for gdb to return to the prompt,
255 # that is the caller's responsibility.
257 proc gdb_run_cmd { {inferior_args {}} } {
258 global gdb_prompt use_gdb_stub
260 foreach command [gdb_init_commands] {
261 send_gdb "$command\n"
263 -re "$gdb_prompt $" { }
265 perror "gdb_init_command for target failed"
272 if [target_info exists gdb,do_reload_on_run] {
273 if { [gdb_reload $inferior_args] != 0 } {
276 send_gdb "continue\n"
278 -re "Continu\[^\r\n\]*\[\r\n\]" {}
284 if [target_info exists gdb,start_symbol] {
285 set start [target_info gdb,start_symbol]
289 send_gdb "jump *$start\n"
291 while { $start_attempt } {
292 # Cap (re)start attempts at three to ensure that this loop
293 # always eventually fails. Don't worry about trying to be
294 # clever and not send a command when it has failed.
295 if [expr $start_attempt > 3] {
296 perror "Jump to start() failed (retry count exceeded)"
299 set start_attempt [expr $start_attempt + 1]
301 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
304 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
305 perror "Can't find start symbol to run in gdb_run"
308 -re "No symbol \"start\" in current.*$gdb_prompt $" {
309 send_gdb "jump *_start\n"
311 -re "No symbol.*context.*$gdb_prompt $" {
314 -re "Line.* Jump anyway.*y or n. $" {
315 send_gdb "y\n" answer
317 -re "The program is not being run.*$gdb_prompt $" {
318 if { [gdb_reload $inferior_args] != 0 } {
321 send_gdb "jump *$start\n"
324 perror "Jump to start() failed (timeout)"
333 if [target_info exists gdb,do_reload_on_run] {
334 if { [gdb_reload $inferior_args] != 0 } {
338 send_gdb "run $inferior_args\n"
339 # This doesn't work quite right yet.
340 # Use -notransfer here so that test cases (like chng-sym.exp)
341 # may test for additional start-up messages.
343 -re "The program .* has been started already.*y or n. $" {
344 send_gdb "y\n" answer
347 -notransfer -re "Starting program: \[^\r\n\]*" {}
348 -notransfer -re "$gdb_prompt $" {
349 # There is no more input expected.
356 # Generic start command. Return 0 if we could start the program, -1
359 # INFERIOR_ARGS is passed as arguments to the start command, so may contain
360 # inferior arguments.
362 # N.B. This function does not wait for gdb to return to the prompt,
363 # that is the caller's responsibility.
365 proc gdb_start_cmd { {inferior_args {}} } {
366 global gdb_prompt use_gdb_stub
368 foreach command [gdb_init_commands] {
369 send_gdb "$command\n"
371 -re "$gdb_prompt $" { }
373 perror "gdb_init_command for target failed"
383 send_gdb "start $inferior_args\n"
384 # Use -notransfer here so that test cases (like chng-sym.exp)
385 # may test for additional start-up messages.
387 -re "The program .* has been started already.*y or n. $" {
388 send_gdb "y\n" answer
391 -notransfer -re "Starting program: \[^\r\n\]*" {
398 # Generic starti command. Return 0 if we could start the program, -1
401 # INFERIOR_ARGS is passed as arguments to the starti command, so may contain
402 # inferior arguments.
404 # N.B. This function does not wait for gdb to return to the prompt,
405 # that is the caller's responsibility.
407 proc gdb_starti_cmd { {inferior_args {}} } {
408 global gdb_prompt use_gdb_stub
410 foreach command [gdb_init_commands] {
411 send_gdb "$command\n"
413 -re "$gdb_prompt $" { }
415 perror "gdb_init_command for target failed"
425 send_gdb "starti $inferior_args\n"
427 -re "The program .* has been started already.*y or n. $" {
428 send_gdb "y\n" answer
431 -re "Starting program: \[^\r\n\]*" {
438 # Set a breakpoint at FUNCTION. If there is an additional argument it is
439 # a list of options; the supported options are allow-pending, temporary,
440 # message, no-message, passfail and qualified.
441 # The result is 1 for success, 0 for failure.
443 # Note: The handling of message vs no-message is messed up, but it's based
444 # on historical usage. By default this function does not print passes,
446 # no-message: turns off printing of fails (and passes, but they're already off)
447 # message: turns on printing of passes (and fails, but they're already on)
449 proc gdb_breakpoint { function args } {
453 set pending_response n
454 if {[lsearch -exact $args allow-pending] != -1} {
455 set pending_response y
458 set break_command "break"
459 set break_message "Breakpoint"
460 if {[lsearch -exact $args temporary] != -1} {
461 set break_command "tbreak"
462 set break_message "Temporary breakpoint"
465 if {[lsearch -exact $args qualified] != -1} {
466 append break_command " -qualified"
471 set no_message_loc [lsearch -exact $args no-message]
472 set message_loc [lsearch -exact $args message]
473 # The last one to appear in args wins.
474 if { $no_message_loc > $message_loc } {
476 } elseif { $message_loc > $no_message_loc } {
480 set test_name "setting breakpoint at $function"
482 send_gdb "$break_command $function\n"
483 # The first two regexps are what we get with -g, the third is without -g.
485 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
486 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
487 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
488 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
489 if {$pending_response == "n"} {
496 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
497 send_gdb "$pending_response\n"
500 -re "A problem internal to GDB has been detected" {
502 fail "$test_name (GDB internal error)"
504 gdb_internal_error_resync
507 -re "$gdb_prompt $" {
515 fail "$test_name (eof)"
521 fail "$test_name (timeout)"
532 # Set breakpoint at function and run gdb until it breaks there.
533 # Since this is the only breakpoint that will be set, if it stops
534 # at a breakpoint, we will assume it is the one we want. We can't
535 # just compare to "function" because it might be a fully qualified,
536 # single quoted C++ function specifier.
538 # If there are additional arguments, pass them to gdb_breakpoint.
539 # We recognize no-message/message ourselves.
540 # The default is no-message.
541 # no-message is messed up here, like gdb_breakpoint: to preserve
542 # historical usage fails are always printed by default.
543 # no-message: turns off printing of fails (and passes, but they're already off)
544 # message: turns on printing of passes (and fails, but they're already on)
546 proc runto { function args } {
552 # Default to "no-message".
553 set args "no-message $args"
557 set no_message_loc [lsearch -exact $args no-message]
558 set message_loc [lsearch -exact $args message]
559 # The last one to appear in args wins.
560 if { $no_message_loc > $message_loc } {
562 } elseif { $message_loc > $no_message_loc } {
566 set test_name "running to $function in runto"
568 # We need to use eval here to pass our varargs args to gdb_breakpoint
569 # which is also a varargs function.
570 # But we also have to be careful because $function may have multiple
571 # elements, and we don't want Tcl to move the remaining elements after
572 # the first to $args. That is why $function is wrapped in {}.
573 if ![eval gdb_breakpoint {$function} $args] {
579 # the "at foo.c:36" output we get with -g.
580 # the "in func" output we get without -g.
582 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
588 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
594 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
596 unsupported "non-stop mode not supported"
600 -re ".*A problem internal to GDB has been detected" {
602 fail "$test_name (GDB internal error)"
604 gdb_internal_error_resync
607 -re "$gdb_prompt $" {
615 fail "$test_name (eof)"
621 fail "$test_name (timeout)"
632 # Ask gdb to run until we hit a breakpoint at main.
634 # N.B. This function deletes all existing breakpoints.
635 # If you don't want that, use gdb_start_cmd.
637 proc runto_main { } {
638 return [runto main no-message]
641 ### Continue, and expect to hit a breakpoint.
642 ### Report a pass or fail, depending on whether it seems to have
643 ### worked. Use NAME as part of the test name; each call to
644 ### continue_to_breakpoint should use a NAME which is unique within
646 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
648 set full_name "continue to breakpoint: $name"
650 set kfail_pattern "Process record does not support instruction 0xfae64 at.*"
651 gdb_test_multiple "continue" $full_name {
652 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
655 -re "\[\r\n\]*(?:$kfail_pattern)\[\r\n\]+$gdb_prompt $" {
656 kfail "gdb/25038" $full_name
662 # gdb_internal_error_resync:
664 # Answer the questions GDB asks after it reports an internal error
665 # until we get back to a GDB prompt. Decline to quit the debugging
666 # session, and decline to create a core file. Return non-zero if the
669 # This procedure just answers whatever questions come up until it sees
670 # a GDB prompt; it doesn't require you to have matched the input up to
671 # any specific point. However, it only answers questions it sees in
672 # the output itself, so if you've matched a question, you had better
673 # answer it yourself before calling this.
675 # You can use this function thus:
679 # -re ".*A problem internal to GDB has been detected" {
680 # gdb_internal_error_resync
685 proc gdb_internal_error_resync {} {
688 verbose -log "Resyncing due to internal error."
691 while {$count < 10} {
693 -re "Quit this debugging session\\? \\(y or n\\) $" {
694 send_gdb "n\n" answer
697 -re "Create a core file of GDB\\? \\(y or n\\) $" {
698 send_gdb "n\n" answer
701 -re "$gdb_prompt $" {
702 # We're resynchronized.
706 perror "Could not resync from internal error (timeout)"
711 perror "Could not resync from internal error (resync count exceeded)"
716 # gdb_test_multiple COMMAND MESSAGE [ -promp PROMPT_REGEXP] [ -lbl ]
718 # Send a command to gdb; test the result.
720 # COMMAND is the command to execute, send to GDB with send_gdb. If
721 # this is the null string no command is sent.
722 # MESSAGE is a message to be printed with the built-in failure patterns
723 # if one of them matches. If MESSAGE is empty COMMAND will be used.
724 # -prompt PROMPT_REGEXP specifies a regexp matching the expected prompt
725 # after the command output. If empty, defaults to "$gdb_prompt $".
726 # -lbl specifies that line-by-line matching will be used.
727 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
728 # patterns. Pattern elements will be evaluated in the caller's
729 # context; action elements will be executed in the caller's context.
730 # Unlike patterns for gdb_test, these patterns should generally include
731 # the final newline and prompt.
734 # 1 if the test failed, according to a built-in failure pattern
735 # 0 if only user-supplied patterns matched
736 # -1 if there was an internal error.
738 # You can use this function thus:
740 # gdb_test_multiple "print foo" "test foo" {
741 # -re "expected output 1" {
744 # -re "expected output 2" {
749 # Within action elements you can also make use of the variable
750 # gdb_test_name. This variable is setup automatically by
751 # gdb_test_multiple, and contains the value of MESSAGE. You can then
752 # write this, which is equivalent to the above:
754 # gdb_test_multiple "print foo" "test foo" {
755 # -re "expected output 1" {
756 # pass $gdb_test_name
758 # -re "expected output 2" {
759 # fail $gdb_test_name
763 # Like with "expect", you can also specify the spawn id to match with
764 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
765 # $gdb_spawn_id. The former matches inferior I/O, while the latter
766 # matches GDB I/O. E.g.:
768 # send_inferior "hello\n"
769 # gdb_test_multiple "continue" "test echo" {
770 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
773 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
774 # fail "hit breakpoint"
778 # The standard patterns, such as "Inferior exited..." and "A problem
779 # ...", all being implicitly appended to that list. These are always
780 # expected from $gdb_spawn_id. IOW, callers do not need to worry
781 # about resetting "-i" back to $gdb_spawn_id explicitly.
783 # In EXPECT_ARGUMENTS we can use a -wrap pattern flag, that wraps the regexp
784 # pattern as gdb_test wraps its message argument.
785 # This allows us to rewrite:
786 # gdb_test <command> <pattern> <message>
788 # gdb_test_multiple <command> <message> {
789 # -re -wrap <pattern> {
790 # pass $gdb_test_name
794 # In EXPECT_ARGUMENTS, a pattern flag -early can be used. It makes sure the
795 # pattern is inserted before any implicit pattern added by gdb_test_multiple.
796 # Using this pattern flag, we can f.i. setup a kfail for an assertion failure
797 # <assert> during gdb_continue_to_breakpoint by the rewrite:
798 # gdb_continue_to_breakpoint <msg> <pattern>
800 # set breakpoint_pattern "(?:Breakpoint|Temporary breakpoint) .* (at|in)"
801 # gdb_test_multiple "continue" "continue to breakpoint: <msg>" {
802 # -early -re "internal-error: <assert>" {
803 # setup_kfail gdb/nnnnn "*-*-*"
806 # -re "$breakpoint_pattern <pattern>\r\n$gdb_prompt $" {
807 # pass $gdb_test_name
811 proc gdb_test_multiple { command message args } {
812 global verbose use_gdb_stub
813 global gdb_prompt pagination_prompt
816 global inferior_exited_re
817 upvar timeout timeout
818 upvar expect_out expect_out
823 for {set i 0} {$i < [llength $args]} {incr i} {
824 set arg [lindex $args $i]
825 if { $arg == "-prompt" } {
827 set prompt_regexp [lindex $args $i]
828 } elseif { $arg == "-lbl" } {
835 if { [expr $i + 1] < [llength $args] } {
836 error "Too many arguments to gdb_test_multiple"
837 } elseif { ![info exists user_code] } {
838 error "Too few arguments to gdb_test_multiple"
841 if { "$prompt_regexp" == "" } {
842 set prompt_regexp "$gdb_prompt $"
845 if { $message == "" } {
849 if [string match "*\[\r\n\]" $command] {
850 error "Invalid trailing newline in \"$message\" test"
853 if [string match "*\[\r\n\]*" $message] {
854 error "Invalid newline in \"$message\" test"
858 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
860 error "gdbserver does not support $command without extended-remote"
863 # TCL/EXPECT WART ALERT
864 # Expect does something very strange when it receives a single braced
865 # argument. It splits it along word separators and performs substitutions.
866 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
867 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
868 # double-quoted list item, "\[ab\]" is just a long way of representing
869 # "[ab]", because the backslashes will be removed by lindex.
871 # Unfortunately, there appears to be no easy way to duplicate the splitting
872 # that expect will do from within TCL. And many places make use of the
873 # "\[0-9\]" construct, so we need to support that; and some places make use
874 # of the "[func]" construct, so we need to support that too. In order to
875 # get this right we have to substitute quoted list elements differently
876 # from braced list elements.
878 # We do this roughly the same way that Expect does it. We have to use two
879 # lists, because if we leave unquoted newlines in the argument to uplevel
880 # they'll be treated as command separators, and if we escape newlines
881 # we mangle newlines inside of command blocks. This assumes that the
882 # input doesn't contain a pattern which contains actual embedded newlines
885 regsub -all {\n} ${user_code} { } subst_code
886 set subst_code [uplevel list $subst_code]
888 set processed_code ""
889 set early_processed_code ""
890 # The variable current_list holds the name of the currently processed
891 # list, either processed_code or early_processed_code.
892 set current_list "processed_code"
894 set expecting_action 0
897 foreach item $user_code subst_item $subst_code {
898 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
899 lappend $current_list $item
902 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
903 lappend $current_list $item
906 if { $item == "-early" } {
907 set current_list "early_processed_code"
910 if { $item == "-timeout" || $item == "-i" } {
912 lappend $current_list $item
915 if { $item == "-wrap" } {
919 if { $expecting_arg } {
921 lappend $current_list $subst_item
924 if { $expecting_action } {
925 lappend $current_list "uplevel [list $item]"
926 set expecting_action 0
927 # Cosmetic, no effect on the list.
928 append $current_list "\n"
929 # End the effect of -early, it only applies to one action.
930 set current_list "processed_code"
933 set expecting_action 1
934 if { $wrap_pattern } {
935 # Wrap subst_item as is done for the gdb_test PATTERN argument.
936 lappend $current_list \
937 "\[\r\n\]*(?:$subst_item)\[\r\n\]+$gdb_prompt $"
940 lappend $current_list $subst_item
942 if {$patterns != ""} {
945 append patterns "\"$subst_item\""
948 # Also purely cosmetic.
949 regsub -all {\r} $patterns {\\r} patterns
950 regsub -all {\n} $patterns {\\n} patterns
953 send_user "Sending \"$command\" to gdb\n"
954 send_user "Looking to match \"$patterns\"\n"
955 send_user "Message is \"$message\"\n"
959 set string "${command}\n"
960 if { $command != "" } {
961 set multi_line_re "\[\r\n\] *>"
962 while { "$string" != "" } {
963 set foo [string first "\n" "$string"]
964 set len [string length "$string"]
965 if { $foo < [expr $len - 1] } {
966 set str [string range "$string" 0 $foo]
967 if { [send_gdb "$str"] != "" } {
970 if { ! $suppress_flag } {
971 perror "Couldn't send $command to GDB."
976 # since we're checking if each line of the multi-line
977 # command are 'accepted' by GDB here,
978 # we need to set -notransfer expect option so that
979 # command output is not lost for pattern matching
982 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
983 timeout { verbose "partial: timeout" 3 }
985 set string [string range "$string" [expr $foo + 1] end]
986 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
991 if { "$string" != "" } {
992 if { [send_gdb "$string"] != "" } {
995 if { ! $suppress_flag } {
996 perror "Couldn't send $command to GDB."
1004 set code $early_processed_code
1006 -re ".*A problem internal to GDB has been detected" {
1007 fail "$message (GDB internal error)"
1008 gdb_internal_error_resync
1011 -re "\\*\\*\\* DOSEXIT code.*" {
1012 if { $message != "" } {
1015 gdb_suppress_entire_file "GDB died"
1019 append code $processed_code
1021 # Reset the spawn id, in case the processed code used -i.
1027 -re "Ending remote debugging.*$prompt_regexp" {
1028 if ![isnative] then {
1029 warning "Can`t communicate to remote target."
1035 -re "Undefined\[a-z\]* command:.*$prompt_regexp" {
1036 perror "Undefined command \"$command\"."
1040 -re "Ambiguous command.*$prompt_regexp" {
1041 perror "\"$command\" is not a unique command name."
1045 -re "$inferior_exited_re with code \[0-9\]+.*$prompt_regexp" {
1046 if ![string match "" $message] then {
1047 set errmsg "$message (the program exited)"
1049 set errmsg "$command (the program exited)"
1054 -re "$inferior_exited_re normally.*$prompt_regexp" {
1055 if ![string match "" $message] then {
1056 set errmsg "$message (the program exited)"
1058 set errmsg "$command (the program exited)"
1063 -re "The program is not being run.*$prompt_regexp" {
1064 if ![string match "" $message] then {
1065 set errmsg "$message (the program is no longer running)"
1067 set errmsg "$command (the program is no longer running)"
1072 -re "\r\n$prompt_regexp" {
1073 if ![string match "" $message] then {
1078 -re "$pagination_prompt" {
1080 perror "Window too small."
1084 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
1085 send_gdb "n\n" answer
1086 gdb_expect -re "$prompt_regexp"
1087 fail "$message (got interactive prompt)"
1090 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
1092 gdb_expect -re "$prompt_regexp"
1093 fail "$message (got breakpoint menu)"
1099 perror "GDB process no longer exists"
1100 set wait_status [wait -i $gdb_spawn_id]
1101 verbose -log "GDB process exited with wait status $wait_status"
1102 if { $message != "" } {
1109 if {$line_by_line} {
1111 -re "\r\n\[^\r\n\]*(?=\r\n)" {
1117 # Now patterns that apply to any spawn id specified.
1121 perror "Process no longer exists"
1122 if { $message != "" } {
1128 perror "internal buffer is full."
1133 if ![string match "" $message] then {
1134 fail "$message (timeout)"
1140 # remote_expect calls the eof section if there is an error on the
1141 # expect call. We already have eof sections above, and we don't
1142 # want them to get called in that situation. Since the last eof
1143 # section becomes the error section, here we define another eof
1144 # section, but with an empty spawn_id list, so that it won't ever
1148 # This comment is here because the eof section must not be
1149 # the empty string, otherwise remote_expect won't realize
1154 # Create gdb_test_name in the parent scope. If this variable
1155 # already exists, which it might if we have nested calls to
1156 # gdb_test_multiple, then preserve the old value, otherwise,
1157 # create a new variable in the parent scope.
1158 upvar gdb_test_name gdb_test_name
1159 if { [info exists gdb_test_name] } {
1160 set gdb_test_name_old "$gdb_test_name"
1162 set gdb_test_name "$message"
1165 set code [catch {gdb_expect $code} string]
1167 # Clean up the gdb_test_name variable. If we had a
1168 # previous value then restore it, otherwise, delete the variable
1169 # from the parent scope.
1170 if { [info exists gdb_test_name_old] } {
1171 set gdb_test_name "$gdb_test_name_old"
1177 global errorInfo errorCode
1178 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1179 } elseif {$code > 1} {
1180 return -code $code $string
1185 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1186 # Send a command to gdb; test the result.
1188 # COMMAND is the command to execute, send to GDB with send_gdb. If
1189 # this is the null string no command is sent.
1190 # PATTERN is the pattern to match for a PASS, and must NOT include
1191 # the \r\n sequence immediately before the gdb prompt. This argument
1192 # may be omitted to just match the prompt, ignoring whatever output
1194 # MESSAGE is an optional message to be printed. If this is
1195 # omitted, then the pass/fail messages use the command string as the
1196 # message. (If this is the empty string, then sometimes we don't
1197 # call pass or fail at all; I don't understand this at all.)
1198 # QUESTION is a question GDB may ask in response to COMMAND, like
1200 # RESPONSE is the response to send if QUESTION appears.
1203 # 1 if the test failed,
1204 # 0 if the test passes,
1205 # -1 if there was an internal error.
1207 proc gdb_test { args } {
1209 upvar timeout timeout
1211 if [llength $args]>2 then {
1212 set message [lindex $args 2]
1214 set message [lindex $args 0]
1216 set command [lindex $args 0]
1217 set pattern [lindex $args 1]
1221 -re "\[\r\n\]*(?:$pattern)\[\r\n\]+$gdb_prompt $" {
1222 if ![string match "" $message] then {
1228 if { [llength $args] == 5 } {
1229 set question_string [lindex $args 3]
1230 set response_string [lindex $args 4]
1232 -re "(${question_string})$" {
1233 send_gdb "$response_string\n"
1239 set user_code [join $user_code]
1240 return [gdb_test_multiple $command $message $user_code]
1243 # Return 1 if version MAJOR.MINOR is at least AT_LEAST_MAJOR.AT_LEAST_MINOR.
1244 proc version_at_least { major minor at_least_major at_least_minor} {
1245 if { $major > $at_least_major } {
1247 } elseif { $major == $at_least_major \
1248 && $minor >= $at_least_minor } {
1255 # Return 1 if tcl version used is at least MAJOR.MINOR
1256 proc tcl_version_at_least { major minor } {
1258 regexp {^([0-9]+)\.([0-9]+)$} $tcl_version \
1259 dummy tcl_version_major tcl_version_minor
1260 return [version_at_least $tcl_version_major $tcl_version_minor \
1264 if { [tcl_version_at_least 8 5] == 0 } {
1265 # lrepeat was added in tcl 8.5. Only add if missing.
1266 proc lrepeat { n element } {
1267 if { [string is integer -strict $n] == 0 } {
1268 error "expected integer but got \"$n\""
1271 error "bad count \"$n\": must be integer >= 0"
1274 for {set i 0} {$i < $n} {incr i} {
1275 lappend res $element
1281 # gdb_test_no_output COMMAND MESSAGE
1282 # Send a command to GDB and verify that this command generated no output.
1284 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1285 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1286 # the message. (If MESSAGE is the empty string, then sometimes we do not
1287 # call pass or fail at all; I don't understand this at all.)
1289 proc gdb_test_no_output { args } {
1291 set command [lindex $args 0]
1292 if [llength $args]>1 then {
1293 set message [lindex $args 1]
1295 set message $command
1298 set command_regex [string_to_regexp $command]
1299 gdb_test_multiple $command $message {
1300 -re "^$command_regex\r\n$gdb_prompt $" {
1301 if ![string match "" $message] then {
1308 # Send a command and then wait for a sequence of outputs.
1309 # This is useful when the sequence is long and contains ".*", a single
1310 # regexp to match the entire output can get a timeout much easier.
1312 # COMMAND is the command to execute, send to GDB with send_gdb. If
1313 # this is the null string no command is sent.
1314 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1315 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1316 # processed in order, and all must be present in the output.
1318 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1319 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1320 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1322 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1323 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1326 # 1 if the test failed,
1327 # 0 if the test passes,
1328 # -1 if there was an internal error.
1330 proc gdb_test_sequence { command test_name expected_output_list } {
1332 if { $test_name == "" } {
1333 set test_name $command
1335 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1336 if { $command != "" } {
1337 send_gdb "$command\n"
1339 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
1343 # Test that a command gives an error. For pass or fail, return
1344 # a 1 to indicate that more tests can proceed. However a timeout
1345 # is a serious error, generates a special fail message, and causes
1346 # a 0 to be returned to indicate that more tests are likely to fail
1349 proc test_print_reject { args } {
1353 if [llength $args]==2 then {
1354 set expectthis [lindex $args 1]
1356 set expectthis "should never match this bogus string"
1358 set sendthis [lindex $args 0]
1359 if $verbose>2 then {
1360 send_user "Sending \"$sendthis\" to gdb\n"
1361 send_user "Looking to match \"$expectthis\"\n"
1363 send_gdb "$sendthis\n"
1364 #FIXME: Should add timeout as parameter.
1366 -re "A .* in expression.*\\.*$gdb_prompt $" {
1367 pass "reject $sendthis"
1370 -re "Invalid syntax in expression.*$gdb_prompt $" {
1371 pass "reject $sendthis"
1374 -re "Junk after end of expression.*$gdb_prompt $" {
1375 pass "reject $sendthis"
1378 -re "Invalid number.*$gdb_prompt $" {
1379 pass "reject $sendthis"
1382 -re "Invalid character constant.*$gdb_prompt $" {
1383 pass "reject $sendthis"
1386 -re "No symbol table is loaded.*$gdb_prompt $" {
1387 pass "reject $sendthis"
1390 -re "No symbol .* in current context.*$gdb_prompt $" {
1391 pass "reject $sendthis"
1394 -re "Unmatched single quote.*$gdb_prompt $" {
1395 pass "reject $sendthis"
1398 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1399 pass "reject $sendthis"
1402 -re "$expectthis.*$gdb_prompt $" {
1403 pass "reject $sendthis"
1406 -re ".*$gdb_prompt $" {
1407 fail "reject $sendthis"
1411 fail "reject $sendthis (eof or timeout)"
1418 # Same as gdb_test, but the second parameter is not a regexp,
1419 # but a string that must match exactly.
1421 proc gdb_test_exact { args } {
1422 upvar timeout timeout
1424 set command [lindex $args 0]
1426 # This applies a special meaning to a null string pattern. Without
1427 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1428 # messages from commands that should have no output except a new
1429 # prompt. With this, only results of a null string will match a null
1432 set pattern [lindex $args 1]
1433 if [string match $pattern ""] {
1434 set pattern [string_to_regexp [lindex $args 0]]
1436 set pattern [string_to_regexp [lindex $args 1]]
1439 # It is most natural to write the pattern argument with only
1440 # embedded \n's, especially if you are trying to avoid Tcl quoting
1441 # problems. But gdb_expect really wants to see \r\n in patterns. So
1442 # transform the pattern here. First transform \r\n back to \n, in
1443 # case some users of gdb_test_exact already do the right thing.
1444 regsub -all "\r\n" $pattern "\n" pattern
1445 regsub -all "\n" $pattern "\r\n" pattern
1446 if [llength $args]==3 then {
1447 set message [lindex $args 2]
1448 return [gdb_test $command $pattern $message]
1451 return [gdb_test $command $pattern]
1454 # Wrapper around gdb_test_multiple that looks for a list of expected
1455 # output elements, but which can appear in any order.
1456 # CMD is the gdb command.
1457 # NAME is the name of the test.
1458 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1460 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1461 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1462 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1464 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1465 # of text per element and then strip trailing \r\n's.
1467 # gdb_test_list_exact "foo" "bar" \
1468 # "\[^\r\n\]+\[\r\n\]+" \
1471 # {expected result 1} \
1472 # {expected result 2} \
1475 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1478 set matches [lsort $result_match_list]
1480 gdb_test_multiple $cmd $name {
1481 "$cmd\[\r\n\]" { exp_continue }
1482 -re $elm_find_regexp {
1483 set str $expect_out(0,string)
1484 verbose -log "seen: $str" 3
1485 regexp -- $elm_extract_regexp $str elm_seen
1486 verbose -log "extracted: $elm_seen" 3
1487 lappend seen $elm_seen
1490 -re "$gdb_prompt $" {
1492 foreach got [lsort $seen] have $matches {
1493 if {![string equal $got $have]} {
1498 if {[string length $failed] != 0} {
1499 fail "$name ($failed not found)"
1507 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1508 # Send a command to gdb; expect inferior and gdb output.
1510 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1513 # INFERIOR_PATTERN is the pattern to match against inferior output.
1515 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1516 # include the \r\n sequence immediately before the gdb prompt, nor the
1517 # prompt. The default is empty.
1519 # Both inferior and gdb patterns must match for a PASS.
1521 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1524 # 1 if the test failed,
1525 # 0 if the test passes,
1526 # -1 if there was an internal error.
1529 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1530 global inferior_spawn_id gdb_spawn_id
1533 if {$message == ""} {
1534 set message $command
1537 set inferior_matched 0
1540 # Use an indirect spawn id list, and remove the inferior spawn id
1541 # from the expected output as soon as it matches, in case
1542 # $inferior_pattern happens to be a prefix of the resulting full
1543 # gdb pattern below (e.g., "\r\n").
1544 global gdb_test_stdio_spawn_id_list
1545 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1547 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1548 # then we may see gdb's output arriving before the inferior's
1550 set res [gdb_test_multiple $command $message {
1551 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1552 set inferior_matched 1
1553 if {!$gdb_matched} {
1554 set gdb_test_stdio_spawn_id_list ""
1558 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1560 if {!$inferior_matched} {
1568 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1573 # get_print_expr_at_depths EXP OUTPUTS
1575 # Used for testing 'set print max-depth'. Prints the expression EXP
1576 # with 'set print max-depth' set to various depths. OUTPUTS is a list
1577 # of `n` different patterns to match at each of the depths from 0 to
1580 # This proc does one final check with the max-depth set to 'unlimited'
1581 # which is tested against the last pattern in the OUTPUTS list. The
1582 # OUTPUTS list is therefore required to match every depth from 0 to a
1583 # depth where the whole of EXP is printed with no ellipsis.
1585 # This proc leaves the 'set print max-depth' set to 'unlimited'.
1586 proc gdb_print_expr_at_depths {exp outputs} {
1587 for { set depth 0 } { $depth <= [llength $outputs] } { incr depth } {
1588 if { $depth == [llength $outputs] } {
1589 set expected_result [lindex $outputs [expr [llength $outputs] - 1]]
1590 set depth_string "unlimited"
1592 set expected_result [lindex $outputs $depth]
1593 set depth_string $depth
1596 with_test_prefix "exp='$exp': depth=${depth_string}" {
1597 gdb_test_no_output "set print max-depth ${depth_string}"
1598 gdb_test "p $exp" "$expected_result"
1605 # Issue a PASS and return true if evaluating CONDITION in the caller's
1606 # frame returns true, and issue a FAIL and return false otherwise.
1607 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1608 # omitted or is empty, then the pass/fail messages use the condition
1609 # string as the message.
1611 proc gdb_assert { condition {message ""} } {
1612 if { $message == ""} {
1613 set message $condition
1616 set res [uplevel 1 expr $condition]
1625 proc gdb_reinitialize_dir { subdir } {
1628 if [is_remote host] {
1633 -re "Reinitialize source path to empty.*y or n. " {
1634 send_gdb "y\n" answer
1636 -re "Source directories searched.*$gdb_prompt $" {
1637 send_gdb "dir $subdir\n"
1639 -re "Source directories searched.*$gdb_prompt $" {
1640 verbose "Dir set to $subdir"
1642 -re "$gdb_prompt $" {
1643 perror "Dir \"$subdir\" failed."
1647 -re "$gdb_prompt $" {
1648 perror "Dir \"$subdir\" failed."
1652 -re "$gdb_prompt $" {
1653 perror "Dir \"$subdir\" failed."
1659 # gdb_exit -- exit the GDB, killing the target program if necessary
1661 proc default_gdb_exit {} {
1663 global INTERNAL_GDBFLAGS GDBFLAGS
1664 global gdb_spawn_id inferior_spawn_id
1665 global inotify_log_file
1667 gdb_stop_suppressing_tests
1669 if ![info exists gdb_spawn_id] {
1673 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1675 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1676 set fd [open $inotify_log_file]
1677 set data [read -nonewline $fd]
1680 if {[string compare $data ""] != 0} {
1681 warning "parallel-unsafe file creations noticed"
1684 set fd [open $inotify_log_file w]
1689 if { [is_remote host] && [board_info host exists fileid] } {
1693 send_gdb "y\n" answer
1696 -re "DOSEXIT code" { }
1701 if ![is_remote host] {
1705 unset inferior_spawn_id
1708 # Load a file into the debugger.
1709 # The return value is 0 for success, -1 for failure.
1711 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1712 # to one of these values:
1714 # debug file was loaded successfully and has debug information
1715 # nodebug file was loaded successfully and has no debug information
1716 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1718 # fail file was not loaded
1720 # I tried returning this information as part of the return value,
1721 # but ran into a mess because of the many re-implementations of
1722 # gdb_load in config/*.exp.
1724 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1725 # this if they can get more information set.
1727 proc gdb_file_cmd { arg } {
1730 global last_loaded_file
1732 # Save this for the benefit of gdbserver-support.exp.
1733 set last_loaded_file $arg
1735 # Set whether debug info was found.
1736 # Default to "fail".
1737 global gdb_file_cmd_debug_info
1738 set gdb_file_cmd_debug_info "fail"
1740 if [is_remote host] {
1741 set arg [remote_download host $arg]
1743 perror "download failed"
1748 # The file command used to kill the remote target. For the benefit
1749 # of the testsuite, preserve this behavior. Mark as optional so it doesn't
1750 # get written to the stdin log.
1751 send_gdb "kill\n" optional
1753 -re "Kill the program being debugged. .y or n. $" {
1754 send_gdb "y\n" answer
1755 verbose "\t\tKilling previous program being debugged"
1758 -re "$gdb_prompt $" {
1763 send_gdb "file $arg\n"
1764 set new_symbol_table 0
1765 set basename [file tail $arg]
1767 -re "Reading symbols from.*LZMA support was disabled.*$gdb_prompt $" {
1768 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1769 set gdb_file_cmd_debug_info "lzma"
1772 -re "Reading symbols from.*no debugging symbols found.*$gdb_prompt $" {
1773 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
1774 set gdb_file_cmd_debug_info "nodebug"
1777 -re "Reading symbols from.*$gdb_prompt $" {
1778 verbose "\t\tLoaded $arg into $GDB"
1779 set gdb_file_cmd_debug_info "debug"
1782 -re "Load new symbol table from \".*\".*y or n. $" {
1783 if { $new_symbol_table > 0 } {
1784 perror [join [list "Couldn't load $basename,"
1785 "interactive prompt loop detected."]]
1788 send_gdb "y\n" answer
1789 incr new_symbol_table
1790 set suffix "-- with new symbol table"
1791 set arg "$arg $suffix"
1792 set basename "$basename $suffix"
1795 -re "No such file or directory.*$gdb_prompt $" {
1796 perror "($basename) No such file or directory"
1799 -re "A problem internal to GDB has been detected" {
1800 perror "Couldn't load $basename into GDB (GDB internal error)."
1801 gdb_internal_error_resync
1804 -re "$gdb_prompt $" {
1805 perror "Couldn't load $basename into GDB."
1809 perror "Couldn't load $basename into GDB (timeout)."
1813 # This is an attempt to detect a core dump, but seems not to
1814 # work. Perhaps we need to match .* followed by eof, in which
1815 # gdb_expect does not seem to have a way to do that.
1816 perror "Couldn't load $basename into GDB (eof)."
1822 # Default gdb_spawn procedure.
1824 proc default_gdb_spawn { } {
1827 global INTERNAL_GDBFLAGS GDBFLAGS
1830 gdb_stop_suppressing_tests
1832 # Set the default value, it may be overriden later by specific testfile.
1834 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1835 # is already started after connecting and run/attach are not supported.
1836 # This is used for the "remote" protocol. After GDB starts you should
1837 # check global $use_gdb_stub instead of the board as the testfile may force
1838 # a specific different target protocol itself.
1839 set use_gdb_stub [target_info exists use_gdb_stub]
1841 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1842 gdb_write_cmd_file "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1844 if [info exists gdb_spawn_id] {
1848 if ![is_remote host] {
1849 if { [which $GDB] == 0 } then {
1850 perror "$GDB does not exist."
1854 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1855 if { $res < 0 || $res == "" } {
1856 perror "Spawning $GDB failed."
1860 set gdb_spawn_id $res
1864 # Default gdb_start procedure.
1866 proc default_gdb_start { } {
1869 global inferior_spawn_id
1871 if [info exists gdb_spawn_id] {
1875 # Keep track of the number of times GDB has been launched.
1876 global gdb_instances
1886 # Default to assuming inferior I/O is done on GDB's terminal.
1887 if {![info exists inferior_spawn_id]} {
1888 set inferior_spawn_id $gdb_spawn_id
1891 # When running over NFS, particularly if running many simultaneous
1892 # tests on different hosts all using the same server, things can
1893 # get really slow. Give gdb at least 3 minutes to start up.
1895 -re "\[\r\n\]$gdb_prompt $" {
1896 verbose "GDB initialized."
1898 -re "$gdb_prompt $" {
1899 perror "GDB never initialized."
1904 perror "(timeout) GDB never initialized after 10 seconds."
1910 perror "(eof) GDB never initialized."
1916 # force the height to "unlimited", so no pagers get used
1918 send_gdb "set height 0\n"
1920 -re "$gdb_prompt $" {
1921 verbose "Setting height to 0." 2
1924 warning "Couldn't set the height to 0"
1927 # force the width to "unlimited", so no wraparound occurs
1928 send_gdb "set width 0\n"
1930 -re "$gdb_prompt $" {
1931 verbose "Setting width to 0." 2
1934 warning "Couldn't set the width to 0."
1942 # Utility procedure to give user control of the gdb prompt in a script. It is
1943 # meant to be used for debugging test cases, and should not be left in the
1946 proc gdb_interact { } {
1948 set spawn_id $gdb_spawn_id
1950 send_user "+------------------------------------------+\n"
1951 send_user "| Script interrupted, you can now interact |\n"
1952 send_user "| with by gdb. Type >>> to continue. |\n"
1953 send_user "+------------------------------------------+\n"
1960 # Examine the output of compilation to determine whether compilation
1961 # failed or not. If it failed determine whether it is due to missing
1962 # compiler or due to compiler error. Report pass, fail or unsupported
1965 proc gdb_compile_test {src output} {
1966 if { $output == "" } {
1967 pass "compilation [file tail $src]"
1968 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1969 unsupported "compilation [file tail $src]"
1970 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1971 unsupported "compilation [file tail $src]"
1972 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1973 unsupported "compilation [file tail $src]"
1975 verbose -log "compilation failed: $output" 2
1976 fail "compilation [file tail $src]"
1980 # Return a 1 for configurations for which we don't even want to try to
1983 proc skip_cplus_tests {} {
1984 if { [istarget "h8300-*-*"] } {
1988 # The C++ IO streams are too large for HC11/HC12 and are thus not
1989 # available. The gdb C++ tests use them and don't compile.
1990 if { [istarget "m6811-*-*"] } {
1993 if { [istarget "m6812-*-*"] } {
1999 # Return a 1 for configurations for which don't have both C++ and the STL.
2001 proc skip_stl_tests {} {
2002 # Symbian supports the C++ language, but the STL is missing
2003 # (both headers and libraries).
2004 if { [istarget "arm*-*-symbianelf*"] } {
2008 return [skip_cplus_tests]
2011 # Return a 1 if I don't even want to try to test FORTRAN.
2013 proc skip_fortran_tests {} {
2017 # Return a 1 if I don't even want to try to test ada.
2019 proc skip_ada_tests {} {
2023 # Return a 1 if I don't even want to try to test GO.
2025 proc skip_go_tests {} {
2029 # Return a 1 if I don't even want to try to test D.
2031 proc skip_d_tests {} {
2035 # Return 1 to skip Rust tests, 0 to try them.
2036 proc skip_rust_tests {} {
2037 return [expr {![isnative]}]
2040 # Return a 1 for configurations that do not support Python scripting.
2041 # PROMPT_REGEXP is the expected prompt.
2043 proc skip_python_tests_prompt { prompt_regexp } {
2044 global gdb_py_is_py3k
2046 gdb_test_multiple "python print ('test')" "verify python support" \
2047 -prompt "$prompt_regexp" {
2048 -re "not supported.*$prompt_regexp" {
2049 unsupported "Python support is disabled."
2052 -re "$prompt_regexp" {}
2055 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" \
2056 -prompt "$prompt_regexp" {
2057 -re "3.*$prompt_regexp" {
2058 set gdb_py_is_py3k 1
2060 -re ".*$prompt_regexp" {
2061 set gdb_py_is_py3k 0
2068 # Return a 1 for configurations that do not support Python scripting.
2069 # Note: This also sets various globals that specify which version of Python
2070 # is in use. See skip_python_tests_prompt.
2072 proc skip_python_tests {} {
2074 return [skip_python_tests_prompt "$gdb_prompt $"]
2077 # Return a 1 if we should skip shared library tests.
2079 proc skip_shlib_tests {} {
2080 # Run the shared library tests on native systems.
2085 # An abbreviated list of remote targets where we should be able to
2086 # run shared library tests.
2087 if {([istarget *-*-linux*]
2088 || [istarget *-*-*bsd*]
2089 || [istarget *-*-solaris2*]
2090 || [istarget arm*-*-symbianelf*]
2091 || [istarget *-*-mingw*]
2092 || [istarget *-*-cygwin*]
2093 || [istarget *-*-pe*])} {
2100 # Return 1 if we should skip tui related tests.
2102 proc skip_tui_tests {} {
2105 gdb_test_multiple "help layout" "verify tui support" {
2106 -re "Undefined command: \"layout\".*$gdb_prompt $" {
2109 -re "$gdb_prompt $" {
2116 # Test files shall make sure all the test result lines in gdb.sum are
2117 # unique in a test run, so that comparing the gdb.sum files of two
2118 # test runs gives correct results. Test files that exercise
2119 # variations of the same tests more than once, shall prefix the
2120 # different test invocations with different identifying strings in
2121 # order to make them unique.
2123 # About test prefixes:
2125 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
2126 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
2127 # underlined substring in
2129 # PASS: gdb.base/mytest.exp: some test
2130 # ^^^^^^^^^^^^^^^^^^^^
2134 # The easiest way to adjust the test prefix is to append a test
2135 # variation prefix to the $pf_prefix, using the with_test_prefix
2138 # proc do_tests {} {
2139 # gdb_test ... ... "test foo"
2140 # gdb_test ... ... "test bar"
2142 # with_test_prefix "subvariation a" {
2143 # gdb_test ... ... "test x"
2146 # with_test_prefix "subvariation b" {
2147 # gdb_test ... ... "test x"
2151 # with_test_prefix "variation1" {
2152 # ...do setup for variation 1...
2156 # with_test_prefix "variation2" {
2157 # ...do setup for variation 2...
2163 # PASS: gdb.base/mytest.exp: variation1: test foo
2164 # PASS: gdb.base/mytest.exp: variation1: test bar
2165 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
2166 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
2167 # PASS: gdb.base/mytest.exp: variation2: test foo
2168 # PASS: gdb.base/mytest.exp: variation2: test bar
2169 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
2170 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
2172 # If for some reason more flexibility is necessary, one can also
2173 # manipulate the pf_prefix global directly, treating it as a string.
2177 # set saved_pf_prefix
2178 # append pf_prefix "${foo}: bar"
2179 # ... actual tests ...
2180 # set pf_prefix $saved_pf_prefix
2183 # Run BODY in the context of the caller, with the current test prefix
2184 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
2185 # Returns the result of BODY.
2187 proc with_test_prefix { prefix body } {
2190 set saved $pf_prefix
2191 append pf_prefix " " $prefix ":"
2192 set code [catch {uplevel 1 $body} result]
2193 set pf_prefix $saved
2196 global errorInfo errorCode
2197 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2199 return -code $code $result
2203 # Wrapper for foreach that calls with_test_prefix on each iteration,
2204 # including the iterator's name and current value in the prefix.
2206 proc foreach_with_prefix {var list body} {
2208 foreach myvar $list {
2209 with_test_prefix "$var=$myvar" {
2210 set code [catch {uplevel 1 $body} result]
2214 global errorInfo errorCode
2215 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2216 } elseif {$code == 3} {
2218 } elseif {$code == 2} {
2219 return -code $code $result
2224 # Like TCL's native proc, but defines a procedure that wraps its body
2225 # within 'with_test_prefix "$proc_name" { ... }'.
2226 proc proc_with_prefix {name arguments body} {
2227 # Define the advertised proc.
2228 proc $name $arguments [list with_test_prefix $name $body]
2232 # Run BODY in the context of the caller. After BODY is run, the variables
2233 # listed in VARS will be reset to the values they had before BODY was run.
2235 # This is useful for providing a scope in which it is safe to temporarily
2236 # modify global variables, e.g.
2238 # global INTERNAL_GDBFLAGS
2241 # set foo GDBHISTSIZE
2243 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2244 # append INTERNAL_GDBFLAGS " -nx"
2245 # unset -nocomplain env(GDBHISTSIZE)
2250 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2251 # modified inside BODY, this proc guarantees that the modifications will be
2252 # undone after BODY finishes executing.
2254 proc save_vars { vars body } {
2255 array set saved_scalars { }
2256 array set saved_arrays { }
2260 # First evaluate VAR in the context of the caller in case the variable
2261 # name may be a not-yet-interpolated string like env($foo)
2262 set var [uplevel 1 list $var]
2264 if [uplevel 1 [list info exists $var]] {
2265 if [uplevel 1 [list array exists $var]] {
2266 set saved_arrays($var) [uplevel 1 [list array get $var]]
2268 set saved_scalars($var) [uplevel 1 [list set $var]]
2271 lappend unset_vars $var
2275 set code [catch {uplevel 1 $body} result]
2277 foreach {var value} [array get saved_scalars] {
2278 uplevel 1 [list set $var $value]
2281 foreach {var value} [array get saved_arrays] {
2282 uplevel 1 [list unset $var]
2283 uplevel 1 [list array set $var $value]
2286 foreach var $unset_vars {
2287 uplevel 1 [list unset -nocomplain $var]
2291 global errorInfo errorCode
2292 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2294 return -code $code $result
2298 # Run tests in BODY with the current working directory (CWD) set to
2299 # DIR. When BODY is finished, restore the original CWD. Return the
2302 # This procedure doesn't check if DIR is a valid directory, so you
2303 # have to make sure of that.
2305 proc with_cwd { dir body } {
2307 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2310 set code [catch {uplevel 1 $body} result]
2312 verbose -log "Switching back to $saved_dir."
2316 global errorInfo errorCode
2317 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2319 return -code $code $result
2323 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2324 # PROMPT. When BODY is finished, restore GDB prompt and variable
2326 # Returns the result of BODY.
2330 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2331 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
2332 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2333 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2334 # a) It's more intuitive for callers to pass the plain text form.
2335 # b) We need two forms of the prompt:
2336 # - a regexp to use in output matching,
2337 # - a value to pass to the "set prompt" command.
2338 # c) It's easier to convert the plain text form to its regexp form.
2340 # 2) Don't add a trailing space, we do that here.
2342 proc with_gdb_prompt { prompt body } {
2345 # Convert "(foo)" to "\(foo\)".
2346 # We don't use string_to_regexp because while it works today it's not
2347 # clear it will work tomorrow: the value we need must work as both a
2348 # regexp *and* as the argument to the "set prompt" command, at least until
2349 # we start recording both forms separately instead of just $gdb_prompt.
2350 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2352 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
2354 set saved $gdb_prompt
2356 verbose -log "Setting gdb prompt to \"$prompt \"."
2357 set gdb_prompt $prompt
2358 gdb_test_no_output "set prompt $prompt " ""
2360 set code [catch {uplevel 1 $body} result]
2362 verbose -log "Restoring gdb prompt to \"$saved \"."
2363 set gdb_prompt $saved
2364 gdb_test_no_output "set prompt $saved " ""
2367 global errorInfo errorCode
2368 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2370 return -code $code $result
2374 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
2375 # BODY is finished, restore target-charset.
2377 proc with_target_charset { target_charset body } {
2381 gdb_test_multiple "show target-charset" "" {
2382 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
2383 set saved $expect_out(1,string)
2385 -re "The target character set is \"(.*)\".*$gdb_prompt " {
2386 set saved $expect_out(1,string)
2388 -re ".*$gdb_prompt " {
2389 fail "get target-charset"
2393 gdb_test_no_output "set target-charset $target_charset" ""
2395 set code [catch {uplevel 1 $body} result]
2397 gdb_test_no_output "set target-charset $saved" ""
2400 global errorInfo errorCode
2401 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2403 return -code $code $result
2407 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
2408 # mi_gdb_test etc. default to using it.
2410 proc switch_gdb_spawn_id {spawn_id} {
2412 global board board_info
2414 set gdb_spawn_id $spawn_id
2415 set board [host_info name]
2416 set board_info($board,fileid) $spawn_id
2419 # Clear the default spawn id.
2421 proc clear_gdb_spawn_id {} {
2423 global board board_info
2425 unset -nocomplain gdb_spawn_id
2426 set board [host_info name]
2427 unset -nocomplain board_info($board,fileid)
2430 # Run BODY with SPAWN_ID as current spawn id.
2432 proc with_spawn_id { spawn_id body } {
2435 if [info exists gdb_spawn_id] {
2436 set saved_spawn_id $gdb_spawn_id
2439 switch_gdb_spawn_id $spawn_id
2441 set code [catch {uplevel 1 $body} result]
2443 if [info exists saved_spawn_id] {
2444 switch_gdb_spawn_id $saved_spawn_id
2450 global errorInfo errorCode
2451 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2453 return -code $code $result
2457 # Select the largest timeout from all the timeouts:
2458 # - the local "timeout" variable of the scope two levels above,
2459 # - the global "timeout" variable,
2460 # - the board variable "gdb,timeout".
2462 proc get_largest_timeout {} {
2463 upvar #0 timeout gtimeout
2464 upvar 2 timeout timeout
2467 if [info exists timeout] {
2470 if { [info exists gtimeout] && $gtimeout > $tmt } {
2473 if { [target_info exists gdb,timeout]
2474 && [target_info gdb,timeout] > $tmt } {
2475 set tmt [target_info gdb,timeout]
2485 # Run tests in BODY with timeout increased by factor of FACTOR. When
2486 # BODY is finished, restore timeout.
2488 proc with_timeout_factor { factor body } {
2491 set savedtimeout $timeout
2493 set timeout [expr [get_largest_timeout] * $factor]
2494 set code [catch {uplevel 1 $body} result]
2496 set timeout $savedtimeout
2498 global errorInfo errorCode
2499 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2501 return -code $code $result
2505 # Run BODY with timeout factor FACTOR if check-read1 is used.
2507 proc with_read1_timeout_factor { factor body } {
2508 if { [info exists ::env(READ1)] == 1 && $::env(READ1) == 1 } {
2509 # Use timeout factor
2511 # Reset timeout factor
2514 return [uplevel [list with_timeout_factor $factor $body]]
2517 # Return 1 if _Complex types are supported, otherwise, return 0.
2519 gdb_caching_proc support_complex_tests {
2521 if { [gdb_skip_float_test] } {
2522 # If floating point is not supported, _Complex is not
2527 # Compile a test program containing _Complex types.
2529 return [gdb_can_simple_compile complex {
2533 _Complex long double cld;
2539 # Return 1 if compiling go is supported.
2540 gdb_caching_proc support_go_compile {
2542 return [gdb_can_simple_compile go-hello {
2546 fmt.Println("hello world")
2551 # Return 1 if GDB can get a type for siginfo from the target, otherwise
2554 proc supports_get_siginfo_type {} {
2555 if { [istarget "*-*-linux*"] } {
2562 # Return 1 if the target supports hardware single stepping.
2564 proc can_hardware_single_step {} {
2566 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
2567 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
2568 || [istarget "nios2-*-*"] } {
2575 # Return 1 if target hardware or OS supports single stepping to signal
2576 # handler, otherwise, return 0.
2578 proc can_single_step_to_signal_handler {} {
2579 # Targets don't have hardware single step. On these targets, when
2580 # a signal is delivered during software single step, gdb is unable
2581 # to determine the next instruction addresses, because start of signal
2582 # handler is one of them.
2583 return [can_hardware_single_step]
2586 # Return 1 if target supports process record, otherwise return 0.
2588 proc supports_process_record {} {
2590 if [target_info exists gdb,use_precord] {
2591 return [target_info gdb,use_precord]
2594 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2595 || [istarget "i\[34567\]86-*-linux*"]
2596 || [istarget "aarch64*-*-linux*"]
2597 || [istarget "powerpc*-*-linux*"]
2598 || [istarget "s390*-*-linux*"] } {
2605 # Return 1 if target supports reverse debugging, otherwise return 0.
2607 proc supports_reverse {} {
2609 if [target_info exists gdb,can_reverse] {
2610 return [target_info gdb,can_reverse]
2613 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2614 || [istarget "i\[34567\]86-*-linux*"]
2615 || [istarget "aarch64*-*-linux*"]
2616 || [istarget "powerpc*-*-linux*"]
2617 || [istarget "s390*-*-linux*"] } {
2624 # Return 1 if readline library is used.
2626 proc readline_is_used { } {
2629 gdb_test_multiple "show editing" "" {
2630 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2633 -re ".*$gdb_prompt $" {
2639 # Return 1 if target is ELF.
2640 gdb_caching_proc is_elf_target {
2641 set me "is_elf_target"
2643 set src { int foo () {return 0;} }
2644 if {![gdb_simple_compile elf_target $src]} {
2648 set fp_obj [open $obj "r"]
2649 fconfigure $fp_obj -translation binary
2650 set data [read $fp_obj]
2655 set ELFMAG "\u007FELF"
2657 if {[string compare -length 4 $data $ELFMAG] != 0} {
2658 verbose "$me: returning 0" 2
2662 verbose "$me: returning 1" 2
2666 # Return 1 if the memory at address zero is readable.
2668 gdb_caching_proc is_address_zero_readable {
2672 gdb_test_multiple "x 0" "" {
2673 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2676 -re ".*$gdb_prompt $" {
2684 # Produce source file NAME and write SOURCES into it.
2686 proc gdb_produce_source { name sources } {
2688 set f [open $name "w"]
2694 # Return 1 if target is ILP32.
2695 # This cannot be decided simply from looking at the target string,
2696 # as it might depend on externally passed compiler options like -m64.
2697 gdb_caching_proc is_ilp32_target {
2698 return [gdb_can_simple_compile is_ilp32_target {
2699 int dummy[sizeof (int) == 4
2700 && sizeof (void *) == 4
2701 && sizeof (long) == 4 ? 1 : -1];
2705 # Return 1 if target is LP64.
2706 # This cannot be decided simply from looking at the target string,
2707 # as it might depend on externally passed compiler options like -m64.
2708 gdb_caching_proc is_lp64_target {
2709 return [gdb_can_simple_compile is_lp64_target {
2710 int dummy[sizeof (int) == 4
2711 && sizeof (void *) == 8
2712 && sizeof (long) == 8 ? 1 : -1];
2716 # Return 1 if target has 64 bit addresses.
2717 # This cannot be decided simply from looking at the target string,
2718 # as it might depend on externally passed compiler options like -m64.
2719 gdb_caching_proc is_64_target {
2720 return [gdb_can_simple_compile is_64_target {
2721 int function(void) { return 3; }
2722 int dummy[sizeof (&function) == 8 ? 1 : -1];
2726 # Return 1 if target has x86_64 registers - either amd64 or x32.
2727 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2728 # just from the target string.
2729 gdb_caching_proc is_amd64_regs_target {
2730 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2734 return [gdb_can_simple_compile is_amd64_regs_target {
2744 # Return 1 if this target is an x86 or x86-64 with -m32.
2745 proc is_x86_like_target {} {
2746 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2749 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2752 # Return 1 if this target is an arm or aarch32 on aarch64.
2754 gdb_caching_proc is_aarch32_target {
2755 if { [istarget "arm*-*-*"] } {
2759 if { ![istarget "aarch64*-*-*"] } {
2766 lappend list "\tmov $reg, $reg"
2769 return [gdb_can_simple_compile aarch32 [join $list \n]]
2772 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2774 proc is_aarch64_target {} {
2775 if { ![istarget "aarch64*-*-*"] } {
2779 return [expr ![is_aarch32_target]]
2782 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2783 proc support_displaced_stepping {} {
2785 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2786 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2787 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2788 || [istarget "aarch64*-*-linux*"] } {
2795 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2796 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2798 gdb_caching_proc skip_altivec_tests {
2799 global srcdir subdir gdb_prompt inferior_exited_re
2801 set me "skip_altivec_tests"
2803 # Some simulators are known to not support VMX instructions.
2804 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2805 verbose "$me: target known to not support VMX, returning 1" 2
2809 # Make sure we have a compiler that understands altivec.
2810 if [get_compiler_info] {
2811 warning "Could not get compiler info"
2814 if [test_compiler_info gcc*] {
2815 set compile_flags "additional_flags=-maltivec"
2816 } elseif [test_compiler_info xlc*] {
2817 set compile_flags "additional_flags=-qaltivec"
2819 verbose "Could not compile with altivec support, returning 1" 2
2823 # Compile a test program containing VMX instructions.
2827 asm volatile ("vor v0,v0,v0");
2829 asm volatile ("vor 0,0,0");
2834 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2838 # Compilation succeeded so now run it via gdb.
2842 gdb_reinitialize_dir $srcdir/$subdir
2846 -re ".*Illegal instruction.*${gdb_prompt} $" {
2847 verbose -log "\n$me altivec hardware not detected"
2848 set skip_vmx_tests 1
2850 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2851 verbose -log "\n$me: altivec hardware detected"
2852 set skip_vmx_tests 0
2855 warning "\n$me: default case taken"
2856 set skip_vmx_tests 1
2860 remote_file build delete $obj
2862 verbose "$me: returning $skip_vmx_tests" 2
2863 return $skip_vmx_tests
2866 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2867 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2869 gdb_caching_proc skip_vsx_tests {
2870 global srcdir subdir gdb_prompt inferior_exited_re
2872 set me "skip_vsx_tests"
2874 # Some simulators are known to not support Altivec instructions, so
2875 # they won't support VSX instructions as well.
2876 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2877 verbose "$me: target known to not support VSX, returning 1" 2
2881 # Make sure we have a compiler that understands altivec.
2882 if [get_compiler_info] {
2883 warning "Could not get compiler info"
2886 if [test_compiler_info gcc*] {
2887 set compile_flags "additional_flags=-mvsx"
2888 } elseif [test_compiler_info xlc*] {
2889 set compile_flags "additional_flags=-qasm=gcc"
2891 verbose "Could not compile with vsx support, returning 1" 2
2895 # Compile a test program containing VSX instructions.
2898 double a[2] = { 1.0, 2.0 };
2900 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2902 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2907 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2911 # No error message, compilation succeeded so now run it via gdb.
2915 gdb_reinitialize_dir $srcdir/$subdir
2919 -re ".*Illegal instruction.*${gdb_prompt} $" {
2920 verbose -log "\n$me VSX hardware not detected"
2921 set skip_vsx_tests 1
2923 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2924 verbose -log "\n$me: VSX hardware detected"
2925 set skip_vsx_tests 0
2928 warning "\n$me: default case taken"
2929 set skip_vsx_tests 1
2933 remote_file build delete $obj
2935 verbose "$me: returning $skip_vsx_tests" 2
2936 return $skip_vsx_tests
2939 # Run a test on the target to see if it supports TSX hardware. Return 0 if so,
2940 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2942 gdb_caching_proc skip_tsx_tests {
2943 global srcdir subdir gdb_prompt inferior_exited_re
2945 set me "skip_tsx_tests"
2947 # Compile a test program.
2950 asm volatile ("xbegin .L0");
2951 asm volatile ("xend");
2952 asm volatile (".L0: nop");
2956 if {![gdb_simple_compile $me $src executable]} {
2960 # No error message, compilation succeeded so now run it via gdb.
2964 gdb_reinitialize_dir $srcdir/$subdir
2968 -re ".*Illegal instruction.*${gdb_prompt} $" {
2969 verbose -log "$me: TSX hardware not detected."
2970 set skip_tsx_tests 1
2972 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2973 verbose -log "$me: TSX hardware detected."
2974 set skip_tsx_tests 0
2977 warning "\n$me: default case taken."
2978 set skip_tsx_tests 1
2982 remote_file build delete $obj
2984 verbose "$me: returning $skip_tsx_tests" 2
2985 return $skip_tsx_tests
2988 # Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2989 # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2991 gdb_caching_proc skip_btrace_tests {
2992 global srcdir subdir gdb_prompt inferior_exited_re
2994 set me "skip_btrace_tests"
2995 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2996 verbose "$me: target does not support btrace, returning 1" 2
3000 # Compile a test program.
3001 set src { int main() { return 0; } }
3002 if {![gdb_simple_compile $me $src executable]} {
3006 # No error message, compilation succeeded so now run it via gdb.
3010 gdb_reinitialize_dir $srcdir/$subdir
3015 # In case of an unexpected output, we return 2 as a fail value.
3016 set skip_btrace_tests 2
3017 gdb_test_multiple "record btrace" "check btrace support" {
3018 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
3019 set skip_btrace_tests 1
3021 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
3022 set skip_btrace_tests 1
3024 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
3025 set skip_btrace_tests 1
3027 -re "^record btrace\r\n$gdb_prompt $" {
3028 set skip_btrace_tests 0
3032 remote_file build delete $obj
3034 verbose "$me: returning $skip_btrace_tests" 2
3035 return $skip_btrace_tests
3038 # Run a test on the target to see if it supports btrace pt hardware.
3039 # Return 0 if so, 1 if it does not. Based on 'check_vmx_hw_available'
3040 # from the GCC testsuite.
3042 gdb_caching_proc skip_btrace_pt_tests {
3043 global srcdir subdir gdb_prompt inferior_exited_re
3045 set me "skip_btrace_tests"
3046 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
3047 verbose "$me: target does not support btrace, returning 1" 2
3051 # Compile a test program.
3052 set src { int main() { return 0; } }
3053 if {![gdb_simple_compile $me $src executable]} {
3057 # No error message, compilation succeeded so now run it via gdb.
3061 gdb_reinitialize_dir $srcdir/$subdir
3066 # In case of an unexpected output, we return 2 as a fail value.
3067 set skip_btrace_tests 2
3068 gdb_test_multiple "record btrace pt" "check btrace pt support" {
3069 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
3070 set skip_btrace_tests 1
3072 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
3073 set skip_btrace_tests 1
3075 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
3076 set skip_btrace_tests 1
3078 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
3079 set skip_btrace_tests 1
3081 -re "^record btrace pt\r\n$gdb_prompt $" {
3082 set skip_btrace_tests 0
3086 remote_file build delete $obj
3088 verbose "$me: returning $skip_btrace_tests" 2
3089 return $skip_btrace_tests
3092 # Run a test on the target to see if it supports Aarch64 SVE hardware.
3093 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
3095 gdb_caching_proc skip_aarch64_sve_tests {
3096 global srcdir subdir gdb_prompt inferior_exited_re
3098 set me "skip_aarch64_sve_tests"
3100 if { ![is_aarch64_target]} {
3104 set compile_flags "{additional_flags=-march=armv8-a+sve}"
3106 # Compile a test program containing SVE instructions.
3109 asm volatile ("ptrue p0.b");
3113 if {![gdb_simple_compile $me $src executable $compile_flags]} {
3117 # Compilation succeeded so now run it via gdb.
3121 -re ".*Illegal instruction.*${gdb_prompt} $" {
3122 verbose -log "\n$me sve hardware not detected"
3123 set skip_sve_tests 1
3125 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3126 verbose -log "\n$me: sve hardware detected"
3127 set skip_sve_tests 0
3130 warning "\n$me: default case taken"
3131 set skip_sve_tests 1
3135 remote_file build delete $obj
3137 verbose "$me: returning $skip_sve_tests" 2
3138 return $skip_sve_tests
3142 # A helper that compiles a test case to see if __int128 is supported.
3143 proc gdb_int128_helper {lang} {
3144 return [gdb_can_simple_compile "i128-for-$lang" {
3146 int main() { return 0; }
3150 # Return true if the C compiler understands the __int128 type.
3151 gdb_caching_proc has_int128_c {
3152 return [gdb_int128_helper c]
3155 # Return true if the C++ compiler understands the __int128 type.
3156 gdb_caching_proc has_int128_cxx {
3157 return [gdb_int128_helper c++]
3160 # Return true if the IFUNC feature is unsupported.
3161 gdb_caching_proc skip_ifunc_tests {
3162 if [gdb_can_simple_compile ifunc {
3164 typedef void F (void);
3165 F* g (void) { return &f_; }
3166 void f () __attribute__ ((ifunc ("g")));
3174 # Return whether we should skip tests for showing inlined functions in
3175 # backtraces. Requires get_compiler_info and get_debug_format.
3177 proc skip_inline_frame_tests {} {
3178 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3179 if { ! [test_debug_format "DWARF 2"] } {
3183 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
3184 if { ([test_compiler_info "gcc-2-*"]
3185 || [test_compiler_info "gcc-3-*"]
3186 || [test_compiler_info "gcc-4-0-*"]) } {
3193 # Return whether we should skip tests for showing variables from
3194 # inlined functions. Requires get_compiler_info and get_debug_format.
3196 proc skip_inline_var_tests {} {
3197 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
3198 if { ! [test_debug_format "DWARF 2"] } {
3205 # Return a 1 if we should skip tests that require hardware breakpoints
3207 proc skip_hw_breakpoint_tests {} {
3208 # Skip tests if requested by the board (note that no_hardware_watchpoints
3209 # disables both watchpoints and breakpoints)
3210 if { [target_info exists gdb,no_hardware_watchpoints]} {
3214 # These targets support hardware breakpoints natively
3215 if { [istarget "i?86-*-*"]
3216 || [istarget "x86_64-*-*"]
3217 || [istarget "ia64-*-*"]
3218 || [istarget "arm*-*-*"]
3219 || [istarget "aarch64*-*-*"]
3220 || [istarget "s390*-*-*"] } {
3227 # Return a 1 if we should skip tests that require hardware watchpoints
3229 proc skip_hw_watchpoint_tests {} {
3230 # Skip tests if requested by the board
3231 if { [target_info exists gdb,no_hardware_watchpoints]} {
3235 # These targets support hardware watchpoints natively
3236 if { [istarget "i?86-*-*"]
3237 || [istarget "x86_64-*-*"]
3238 || [istarget "ia64-*-*"]
3239 || [istarget "arm*-*-*"]
3240 || [istarget "aarch64*-*-*"]
3241 || [istarget "powerpc*-*-linux*"]
3242 || [istarget "s390*-*-*"] } {
3249 # Return a 1 if we should skip tests that require *multiple* hardware
3250 # watchpoints to be active at the same time
3252 proc skip_hw_watchpoint_multi_tests {} {
3253 if { [skip_hw_watchpoint_tests] } {
3257 # These targets support just a single hardware watchpoint
3258 if { [istarget "arm*-*-*"]
3259 || [istarget "powerpc*-*-linux*"] } {
3266 # Return a 1 if we should skip tests that require read/access watchpoints
3268 proc skip_hw_watchpoint_access_tests {} {
3269 if { [skip_hw_watchpoint_tests] } {
3273 # These targets support just write watchpoints
3274 if { [istarget "s390*-*-*"] } {
3281 # Return 1 if we should skip tests that require the runtime unwinder
3282 # hook. This must be invoked while gdb is running, after shared
3283 # libraries have been loaded. This is needed because otherwise a
3284 # shared libgcc won't be visible.
3286 proc skip_unwinder_tests {} {
3290 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3291 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3293 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
3296 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
3300 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3301 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
3304 -re "\r\n$gdb_prompt $" {
3311 # Return 1 if we should skip tests that require the libstdc++ stap
3312 # probes. This must be invoked while gdb is running, after shared
3313 # libraries have been loaded. PROMPT_REGEXP is the expected prompt.
3315 proc skip_libstdcxx_probe_tests_prompt { prompt_regexp } {
3317 gdb_test_multiple "info probe" "check for stap probe in libstdc++" \
3318 -prompt "$prompt_regexp" {
3319 -re ".*libstdcxx.*catch.*\r\n$prompt_regexp" {
3322 -re "\r\n$prompt_regexp" {
3325 set skip [expr !$supported]
3329 # As skip_libstdcxx_probe_tests_prompt, with gdb_prompt.
3331 proc skip_libstdcxx_probe_tests {} {
3333 return [skip_libstdcxx_probe_tests_prompt "$gdb_prompt $"]
3336 # Return 1 if we should skip tests of the "compile" feature.
3337 # This must be invoked after the inferior has been started.
3339 proc skip_compile_feature_tests {} {
3343 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3344 "Could not load libcc1.*\r\n$gdb_prompt $" {
3347 -re "Command not supported on this host\\..*\r\n$gdb_prompt $" {
3350 -re "\r\n$gdb_prompt $" {
3356 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3357 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
3358 # is a regexp that will match the output of "maint print target-stack" if
3359 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3360 # matching the expected prompt after the command output.
3362 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
3363 set test "probe for target ${target_name}"
3364 gdb_test_multiple "maint print target-stack" $test \
3365 -prompt "$prompt_regexp" {
3366 -re "${target_stack_regexp}${prompt_regexp}" {
3370 -re "$prompt_regexp" {
3377 # Helper for gdb_is_target_remote where the expected prompt is variable.
3379 proc gdb_is_target_remote_prompt { prompt_regexp } {
3380 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3383 # Check whether we're testing with the remote or extended-remote
3386 proc gdb_is_target_remote { } {
3389 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3392 # Check whether we're testing with the native target.
3394 proc gdb_is_target_native { } {
3397 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
3400 # Return the effective value of use_gdb_stub.
3402 # If the use_gdb_stub global has been set (it is set when the gdb process is
3403 # spawned), return that. Otherwise, return the value of the use_gdb_stub
3404 # property from the board file.
3406 # This is the preferred way of checking use_gdb_stub, since it allows to check
3407 # the value before the gdb has been spawned and it will return the correct value
3408 # even when it was overriden by the test.
3410 proc use_gdb_stub {} {
3413 if [info exists use_gdb_stub] {
3414 return $use_gdb_stub
3417 return [target_info exists use_gdb_stub]
3420 # Return 1 if the current remote target is an instance of our GDBserver, 0
3421 # otherwise. Return -1 if there was an error and we can't tell.
3423 gdb_caching_proc target_is_gdbserver {
3427 set test "probing for GDBserver"
3429 gdb_test_multiple "monitor help" $test {
3430 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3433 -re "$gdb_prompt $" {
3438 if { $is_gdbserver == -1 } {
3439 verbose -log "Unable to tell whether we are using GDBserver or not."
3442 return $is_gdbserver
3445 # N.B. compiler_info is intended to be local to this file.
3446 # Call test_compiler_info with no arguments to fetch its value.
3447 # Yes, this is counterintuitive when there's get_compiler_info,
3448 # but that's the current API.
3449 if [info exists compiler_info] {
3455 # Figure out what compiler I am using.
3456 # The result is cached so only the first invocation runs the compiler.
3458 # ARG can be empty or "C++". If empty, "C" is assumed.
3460 # There are several ways to do this, with various problems.
3462 # [ gdb_compile -E $ifile -o $binfile.ci ]
3463 # source $binfile.ci
3465 # Single Unix Spec v3 says that "-E -o ..." together are not
3466 # specified. And in fact, the native compiler on hp-ux 11 (among
3467 # others) does not work with "-E -o ...". Most targets used to do
3468 # this, and it mostly worked, because it works with gcc.
3470 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3471 # source $binfile.ci
3473 # This avoids the problem with -E and -o together. This almost works
3474 # if the build machine is the same as the host machine, which is
3475 # usually true of the targets which are not gcc. But this code does
3476 # not figure which compiler to call, and it always ends up using the C
3477 # compiler. Not good for setting hp_aCC_compiler. Target
3478 # hppa*-*-hpux* used to do this.
3480 # [ gdb_compile -E $ifile > $binfile.ci ]
3481 # source $binfile.ci
3483 # dejagnu target_compile says that it supports output redirection,
3484 # but the code is completely different from the normal path and I
3485 # don't want to sweep the mines from that path. So I didn't even try
3488 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3491 # I actually do this for all targets now. gdb_compile runs the right
3492 # compiler, and TCL captures the output, and I eval the output.
3494 # Unfortunately, expect logs the output of the command as it goes by,
3495 # and dejagnu helpfully prints a second copy of it right afterwards.
3496 # So I turn off expect logging for a moment.
3498 # [ gdb_compile $ifile $ciexe_file executable $args ]
3499 # [ remote_exec $ciexe_file ]
3500 # [ source $ci_file.out ]
3502 # I could give up on -E and just do this.
3503 # I didn't get desperate enough to try this.
3505 # -- chastain 2004-01-06
3507 proc get_compiler_info {{arg ""}} {
3508 # For compiler.c and compiler.cc
3511 # I am going to play with the log to keep noise out.
3515 # These come from compiler.c or compiler.cc
3516 global compiler_info
3518 # Legacy global data symbols.
3521 if [info exists compiler_info] {
3526 # Choose which file to preprocess.
3527 set ifile "${srcdir}/lib/compiler.c"
3528 if { $arg == "c++" } {
3529 set ifile "${srcdir}/lib/compiler.cc"
3532 # Run $ifile through the right preprocessor.
3533 # Toggle gdb.log to keep the compiler output out of the log.
3534 set saved_log [log_file -info]
3536 if [is_remote host] {
3537 # We have to use -E and -o together, despite the comments
3538 # above, because of how DejaGnu handles remote host testing.
3539 set ppout "$outdir/compiler.i"
3540 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet getting_compiler_info]
3541 set file [open $ppout r]
3542 set cppout [read $file]
3545 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet getting_compiler_info] ]
3547 eval log_file $saved_log
3551 foreach cppline [ split "$cppout" "\n" ] {
3552 if { [ regexp "^#" "$cppline" ] } {
3554 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
3556 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
3558 verbose "get_compiler_info: $cppline" 2
3562 verbose -log "get_compiler_info: $cppline"
3567 # Set to unknown if for some reason compiler_info didn't get defined.
3568 if ![info exists compiler_info] {
3569 verbose -log "get_compiler_info: compiler_info not provided"
3570 set compiler_info "unknown"
3572 # Also set to unknown compiler if any diagnostics happened.
3574 verbose -log "get_compiler_info: got unexpected diagnostics"
3575 set compiler_info "unknown"
3578 # Set the legacy symbols.
3580 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3582 # Log what happened.
3583 verbose -log "get_compiler_info: $compiler_info"
3585 # Most compilers will evaluate comparisons and other boolean
3586 # operations to 0 or 1.
3587 uplevel \#0 { set true 1 }
3588 uplevel \#0 { set false 0 }
3593 # Return the compiler_info string if no arg is provided.
3594 # Otherwise the argument is a glob-style expression to match against
3597 proc test_compiler_info { {compiler ""} } {
3598 global compiler_info
3601 # If no arg, return the compiler_info string.
3602 if [string match "" $compiler] {
3603 return $compiler_info
3606 return [string match $compiler $compiler_info]
3609 proc current_target_name { } {
3611 if [info exists target_info(target,name)] {
3612 set answer $target_info(target,name)
3619 set gdb_wrapper_initialized 0
3620 set gdb_wrapper_target ""
3622 proc gdb_wrapper_init { args } {
3623 global gdb_wrapper_initialized
3624 global gdb_wrapper_file
3625 global gdb_wrapper_flags
3626 global gdb_wrapper_target
3628 # If the wrapper is initialized but the wrapper file cannot be
3629 # found anymore, the wrapper file must be built again.
3630 if { $gdb_wrapper_initialized == 1 && \
3631 [info exists gdb_wrapper_file] && \
3632 ![file exists $gdb_wrapper_file] } {
3633 verbose "reinitializing the wrapper"
3634 set gdb_wrapper_initialized 0
3637 if { $gdb_wrapper_initialized == 1 } { return; }
3639 if {[target_info exists needs_status_wrapper] && \
3640 [target_info needs_status_wrapper] != "0"} {
3641 set result [build_wrapper [standard_output_file "testglue.o"]]
3642 if { $result != "" } {
3643 set gdb_wrapper_file [lindex $result 0]
3644 set gdb_wrapper_flags [lindex $result 1]
3646 warning "Status wrapper failed to build."
3649 set gdb_wrapper_initialized 1
3650 set gdb_wrapper_target [current_target_name]
3653 # Determine options that we always want to pass to the compiler.
3654 gdb_caching_proc universal_compile_options {
3655 set me "universal_compile_options"
3658 set src [standard_temp_file ccopts[pid].c]
3659 set obj [standard_temp_file ccopts[pid].o]
3661 gdb_produce_source $src {
3662 int foo(void) { return 0; }
3665 # Try an option for disabling colored diagnostics. Some compilers
3666 # yield colored diagnostics by default (when run from a tty) unless
3667 # such an option is specified.
3668 set opt "additional_flags=-fdiagnostics-color=never"
3669 set lines [target_compile $src $obj object [list "quiet" $opt]]
3670 if [string match "" $lines] then {
3671 # Seems to have worked; use the option.
3672 lappend options $opt
3677 verbose "$me: returning $options" 2
3681 # Compile the code in $code to a file based on $name, using the flags
3682 # $compile_flag as well as debug, nowarning and quiet.
3683 # Return 1 if code can be compiled
3684 # Leave the file name of the resulting object in the upvar object.
3686 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3689 switch -regexp -- $type {
3704 foreach flag $compile_flags {
3705 if { "$flag" == "go" } {
3710 set src [standard_temp_file $name-[pid].$ext]
3711 set obj [standard_temp_file $name-[pid].$postfix]
3712 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3714 gdb_produce_source $src $code
3716 verbose "$name: compiling testfile $src" 2
3717 set lines [gdb_compile $src $obj $type $compile_flags]
3721 if ![string match "" $lines] then {
3722 verbose "$name: compilation failed, returning 0" 2
3728 # Compile the code in $code to a file based on $name, using the flags
3729 # $compile_flag as well as debug, nowarning and quiet.
3730 # Return 1 if code can be compiled
3731 # Delete all created files and objects.
3733 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3734 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3735 file delete $temp_obj
3739 # Some targets need to always link a special object in. Save its path here.
3740 global gdb_saved_set_unbuffered_mode_obj
3741 set gdb_saved_set_unbuffered_mode_obj ""
3743 # Compile source files specified by SOURCE into a binary of type TYPE at path
3744 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
3745 # parameter and most options are passed directly to it.
3747 # The type can be one of the following:
3749 # - object: Compile into an object file.
3750 # - executable: Compile and link into an executable.
3751 # - preprocess: Preprocess the source files.
3752 # - assembly: Generate assembly listing.
3754 # The following options are understood and processed by gdb_compile:
3756 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
3757 # quirks to be able to use shared libraries.
3758 # - shlib_load: Link with appropriate libraries to allow the test to
3759 # dynamically load libraries at runtime. For example, on Linux, this adds
3760 # -ldl so that the test can use dlopen.
3761 # - nowarnings: Inhibit all compiler warnings.
3762 # - pie: Force creation of PIE executables.
3763 # - nopie: Prevent creation of PIE executables.
3765 # And here are some of the not too obscure options understood by DejaGnu that
3766 # influence the compilation:
3768 # - additional_flags=flag: Add FLAG to the compiler flags.
3769 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
3770 # argument can be a file, in which case it's added to the sources, or a
3772 # - ldflags=flag: Add FLAG to the linker flags.
3773 # - incdir=path: Add PATH to the searched include directories.
3774 # - libdir=path: Add PATH to the linker searched directories.
3775 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3776 # - debug: Build with debug information.
3777 # - optimize: Build with optimization.
3779 proc gdb_compile {source dest type options} {
3780 global GDB_TESTCASE_OPTIONS
3781 global gdb_wrapper_file
3782 global gdb_wrapper_flags
3783 global gdb_wrapper_initialized
3786 global gdb_saved_set_unbuffered_mode_obj
3788 set outdir [file dirname $dest]
3790 # Add platform-specific options if a shared library was specified using
3791 # "shlib=librarypath" in OPTIONS.
3793 if {[lsearch -exact $options rust] != -1} {
3794 # -fdiagnostics-color is not a rustcc option.
3796 set new_options [universal_compile_options]
3799 # Place (and look for) Fortran `.mod` files in the output
3800 # directory for this specific test.
3801 if {[lsearch -exact $options f77] != -1 \
3802 || [lsearch -exact $options f90] != -1 } {
3804 set mod_path [standard_output_file ""]
3805 lappend new_options "additional_flags=-J${mod_path}"
3810 set getting_compiler_info 0
3811 foreach opt $options {
3812 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3813 && $type == "executable"} {
3814 if [test_compiler_info "xlc-*"] {
3815 # IBM xlc compiler doesn't accept shared library named other
3816 # than .so: use "-Wl," to bypass this
3817 lappend source "-Wl,$shlib_name"
3818 } elseif { ([istarget "*-*-mingw*"]
3819 || [istarget *-*-cygwin*]
3820 || [istarget *-*-pe*])} {
3821 lappend source "${shlib_name}.a"
3823 lappend source $shlib_name
3825 if { $shlib_found == 0 } {
3827 if { ([istarget "*-*-mingw*"]
3828 || [istarget *-*-cygwin*]) } {
3829 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3831 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
3832 # Undo debian's change in the default.
3833 # Put it at the front to not override any user-provided
3834 # value, and to make sure it appears in front of all the
3836 lappend new_options "early_flags=-Wl,--no-as-needed"
3839 } elseif { $opt == "shlib_load" && $type == "executable" } {
3841 } elseif { $opt == "getting_compiler_info" } {
3842 # If this is set, calling test_compiler_info will cause recursion.
3843 set getting_compiler_info 1
3845 lappend new_options $opt
3849 # Ensure stack protector is disabled for GCC, as this causes problems with
3850 # DWARF line numbering.
3851 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
3852 # This option defaults to on for Debian/Ubuntu.
3853 if { $getting_compiler_info == 0
3854 && [test_compiler_info {gcc-*-*}]
3855 && !([test_compiler_info {gcc-[0-3]-*}]
3856 || [test_compiler_info {gcc-4-0-*}])
3857 && [lsearch -exact $options rust] == -1} {
3858 # Put it at the front to not override any user-provided value.
3859 lappend new_options "early_flags=-fno-stack-protector"
3862 # Because we link with libraries using their basename, we may need
3863 # (depending on the platform) to set a special rpath value, to allow
3864 # the executable to find the libraries it depends on.
3865 if { $shlib_load || $shlib_found } {
3866 if { ([istarget "*-*-mingw*"]
3867 || [istarget *-*-cygwin*]
3868 || [istarget *-*-pe*]) } {
3869 # Do not need anything.
3870 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3871 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3872 } elseif { [istarget arm*-*-symbianelf*] } {
3873 if { $shlib_load } {
3874 lappend new_options "libs=-ldl"
3877 if { $shlib_load } {
3878 lappend new_options "libs=-ldl"
3880 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
3883 set options $new_options
3885 if [info exists GDB_TESTCASE_OPTIONS] {
3886 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3888 verbose "options are $options"
3889 verbose "source is $source $dest $type $options"
3893 if {[target_info exists needs_status_wrapper] && \
3894 [target_info needs_status_wrapper] != "0" && \
3895 [info exists gdb_wrapper_file]} {
3896 lappend options "libs=${gdb_wrapper_file}"
3897 lappend options "ldflags=${gdb_wrapper_flags}"
3900 # Replace the "nowarnings" option with the appropriate additional_flags
3901 # to disable compiler warnings.
3902 set nowarnings [lsearch -exact $options nowarnings]
3903 if {$nowarnings != -1} {
3904 if [target_info exists gdb,nowarnings_flag] {
3905 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3907 set flag "additional_flags=-w"
3909 set options [lreplace $options $nowarnings $nowarnings $flag]
3912 # Replace the "pie" option with the appropriate compiler and linker flags
3913 # to enable PIE executables.
3914 set pie [lsearch -exact $options pie]
3916 if [target_info exists gdb,pie_flag] {
3917 set flag "additional_flags=[target_info gdb,pie_flag]"
3919 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
3920 # and SPARC, fpie can cause compile errors due to the GOT exceeding
3921 # a maximum size. On other architectures the two flags are
3922 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
3923 # onwards default GCC to using fPIE. If you do require fpie, then
3924 # it can be set using the pie_flag.
3925 set flag "additional_flags=-fPIE"
3927 set options [lreplace $options $pie $pie $flag]
3929 if [target_info exists gdb,pie_ldflag] {
3930 set flag "ldflags=[target_info gdb,pie_ldflag]"
3932 set flag "ldflags=-pie"
3934 lappend options "$flag"
3937 # Replace the "nopie" option with the appropriate linker flag to disable
3938 # PIE executables. There are no compiler flags for this option.
3939 set nopie [lsearch -exact $options nopie]
3941 if [target_info exists gdb,nopie_flag] {
3942 set flag "ldflags=[target_info gdb,nopie_flag]"
3944 set flag "ldflags=-no-pie"
3946 set options [lreplace $options $nopie $nopie $flag]
3949 if { $type == "executable" } {
3950 if { ([istarget "*-*-mingw*"]
3951 || [istarget "*-*-*djgpp"]
3952 || [istarget "*-*-cygwin*"])} {
3953 # Force output to unbuffered mode, by linking in an object file
3954 # with a global contructor that calls setvbuf.
3956 # Compile the special object separately for two reasons:
3957 # 1) Insulate it from $options.
3958 # 2) Avoid compiling it for every gdb_compile invocation,
3959 # which is time consuming, especially if we're remote
3962 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
3963 verbose "compiling gdb_saved_set_unbuffered_obj"
3964 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
3965 set unbuf_obj ${objdir}/set_unbuffered_mode.o
3967 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
3968 if { $result != "" } {
3971 if {[is_remote host]} {
3972 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3974 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
3976 # Link a copy of the output object, because the
3977 # original may be automatically deleted.
3978 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3980 verbose "gdb_saved_set_unbuffered_obj already compiled"
3983 # Rely on the internal knowledge that the global ctors are ran in
3984 # reverse link order. In that case, we can use ldflags to
3985 # avoid copying the object file to the host multiple
3987 # This object can only be added if standard libraries are
3988 # used. Thus, we need to disable it if -nostdlib option is used
3989 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
3990 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3995 set result [target_compile $source $dest $type $options]
3997 # Prune uninteresting compiler (and linker) output.
3998 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
4000 regsub "\[\r\n\]*$" "$result" "" result
4001 regsub "^\[\r\n\]*" "$result" "" result
4003 if { $type == "executable" && $result == "" \
4004 && ($nopie != -1 || $pie != -1) } {
4005 set is_pie [exec_is_pie "$dest"]
4006 if { $nopie != -1 && $is_pie == 1 } {
4007 set result "nopie failed to prevent PIE executable"
4008 } elseif { $pie != -1 && $is_pie == 0 } {
4009 set result "pie failed to generate PIE executable"
4013 if {[lsearch $options quiet] < 0} {
4014 # We shall update this on a per language basis, to avoid
4015 # changing the entire testsuite in one go.
4016 if {[lsearch $options f77] >= 0} {
4017 gdb_compile_test $source $result
4018 } elseif { $result != "" } {
4019 clone_output "gdb compile failed, $result"
4026 # This is just like gdb_compile, above, except that it tries compiling
4027 # against several different thread libraries, to see which one this
4029 proc gdb_compile_pthreads {source dest type options} {
4030 if {$type != "executable"} {
4031 return [gdb_compile $source $dest $type $options]
4034 set why_msg "unrecognized error"
4035 foreach lib {-lpthreads -lpthread -lthread ""} {
4036 # This kind of wipes out whatever libs the caller may have
4037 # set. Or maybe theirs will override ours. How infelicitous.
4038 set options_with_lib [concat $options [list libs=$lib quiet]]
4039 set ccout [gdb_compile $source $dest $type $options_with_lib]
4040 switch -regexp -- $ccout {
4041 ".*no posix threads support.*" {
4042 set why_msg "missing threads include file"
4045 ".*cannot open -lpthread.*" {
4046 set why_msg "missing runtime threads library"
4048 ".*Can't find library for -lpthread.*" {
4049 set why_msg "missing runtime threads library"
4052 pass "successfully compiled posix threads test case"
4058 if {!$built_binfile} {
4059 unsupported "couldn't compile [file tail $source]: ${why_msg}"
4064 # Build a shared library from SOURCES.
4066 proc gdb_compile_shlib {sources dest options} {
4067 set obj_options $options
4070 if { [lsearch -exact $options "c++"] >= 0 } {
4071 set info_options "c++"
4073 if [get_compiler_info ${info_options}] {
4077 switch -glob [test_compiler_info] {
4079 lappend obj_options "additional_flags=-qpic"
4082 if { !([istarget "*-*-cygwin*"]
4083 || [istarget "*-*-mingw*"]) } {
4084 lappend obj_options "additional_flags=-fpic"
4088 if { !([istarget "powerpc*-*-aix*"]
4089 || [istarget "rs6000*-*-aix*"]
4090 || [istarget "*-*-cygwin*"]
4091 || [istarget "*-*-mingw*"]
4092 || [istarget "*-*-pe*"]) } {
4093 lappend obj_options "additional_flags=-fpic"
4097 lappend obj_options "additional_flags=-fpic"
4100 # don't know what the compiler is...
4104 set outdir [file dirname $dest]
4106 foreach source $sources {
4107 set sourcebase [file tail $source]
4108 if {[file extension $source] == ".o"} {
4109 # Already a .o file.
4110 lappend objects $source
4111 } elseif {[gdb_compile $source "${outdir}/${sourcebase}.o" object \
4112 $obj_options] != ""} {
4115 lappend objects ${outdir}/${sourcebase}.o
4119 set link_options $options
4120 if [test_compiler_info "xlc-*"] {
4121 lappend link_options "additional_flags=-qmkshrobj"
4123 lappend link_options "additional_flags=-shared"
4125 if { ([istarget "*-*-mingw*"]
4126 || [istarget *-*-cygwin*]
4127 || [istarget *-*-pe*]) } {
4128 if { [is_remote host] } {
4129 set name [file tail ${dest}]
4133 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
4135 # Set the soname of the library. This causes the linker on ELF
4136 # systems to create the DT_NEEDED entry in the executable referring
4137 # to the soname of the library, and not its absolute path. This
4138 # (using the absolute path) would be problem when testing on a
4141 # In conjunction with setting the soname, we add the special
4142 # rpath=$ORIGIN value when building the executable, so that it's
4143 # able to find the library in its own directory.
4144 set destbase [file tail $dest]
4145 lappend link_options "additional_flags=-Wl,-soname,$destbase"
4148 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
4151 if { [is_remote host]
4152 && ([istarget "*-*-mingw*"]
4153 || [istarget *-*-cygwin*]
4154 || [istarget *-*-pe*]) } {
4155 set dest_tail_name [file tail ${dest}]
4156 remote_upload host $dest_tail_name.a ${dest}.a
4157 remote_file host delete $dest_tail_name.a
4163 # This is just like gdb_compile_shlib, above, except that it tries compiling
4164 # against several different thread libraries, to see which one this
4166 proc gdb_compile_shlib_pthreads {sources dest options} {
4168 set why_msg "unrecognized error"
4169 foreach lib {-lpthreads -lpthread -lthread ""} {
4170 # This kind of wipes out whatever libs the caller may have
4171 # set. Or maybe theirs will override ours. How infelicitous.
4172 set options_with_lib [concat $options [list libs=$lib quiet]]
4173 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
4174 switch -regexp -- $ccout {
4175 ".*no posix threads support.*" {
4176 set why_msg "missing threads include file"
4179 ".*cannot open -lpthread.*" {
4180 set why_msg "missing runtime threads library"
4182 ".*Can't find library for -lpthread.*" {
4183 set why_msg "missing runtime threads library"
4186 pass "successfully compiled posix threads test case"
4192 if {!$built_binfile} {
4193 unsupported "couldn't compile $sources: ${why_msg}"
4198 # This is just like gdb_compile_pthreads, above, except that we always add the
4199 # objc library for compiling Objective-C programs
4200 proc gdb_compile_objc {source dest type options} {
4202 set why_msg "unrecognized error"
4203 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
4204 # This kind of wipes out whatever libs the caller may have
4205 # set. Or maybe theirs will override ours. How infelicitous.
4206 if { $lib == "solaris" } {
4207 set lib "-lpthread -lposix4"
4209 if { $lib != "-lobjc" } {
4210 set lib "-lobjc $lib"
4212 set options_with_lib [concat $options [list libs=$lib quiet]]
4213 set ccout [gdb_compile $source $dest $type $options_with_lib]
4214 switch -regexp -- $ccout {
4215 ".*no posix threads support.*" {
4216 set why_msg "missing threads include file"
4219 ".*cannot open -lpthread.*" {
4220 set why_msg "missing runtime threads library"
4222 ".*Can't find library for -lpthread.*" {
4223 set why_msg "missing runtime threads library"
4226 pass "successfully compiled objc with posix threads test case"
4232 if {!$built_binfile} {
4233 unsupported "couldn't compile [file tail $source]: ${why_msg}"
4238 # Build an OpenMP program from SOURCE. See prefatory comment for
4239 # gdb_compile, above, for discussion of the parameters to this proc.
4241 proc gdb_compile_openmp {source dest type options} {
4242 lappend options "additional_flags=-fopenmp"
4243 return [gdb_compile $source $dest $type $options]
4246 # Send a command to GDB.
4247 # For options for TYPE see gdb_stdin_log_write
4249 proc send_gdb { string {type standard}} {
4250 global suppress_flag
4251 if { $suppress_flag } {
4254 gdb_stdin_log_write $string $type
4255 return [remote_send host "$string"]
4258 # Send STRING to the inferior's terminal.
4260 proc send_inferior { string } {
4261 global inferior_spawn_id
4263 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
4273 proc gdb_expect { args } {
4274 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
4275 set atimeout [lindex $args 0]
4276 set expcode [list [lindex $args 1]]
4281 # A timeout argument takes precedence, otherwise of all the timeouts
4282 # select the largest.
4283 if [info exists atimeout] {
4286 set tmt [get_largest_timeout]
4289 global suppress_flag
4290 global remote_suppress_flag
4291 if [info exists remote_suppress_flag] {
4292 set old_val $remote_suppress_flag
4294 if [info exists suppress_flag] {
4295 if { $suppress_flag } {
4296 set remote_suppress_flag 1
4300 {uplevel remote_expect host $tmt $expcode} string]
4301 if [info exists old_val] {
4302 set remote_suppress_flag $old_val
4304 if [info exists remote_suppress_flag] {
4305 unset remote_suppress_flag
4310 global errorInfo errorCode
4312 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
4314 return -code $code $string
4318 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
4320 # Check for long sequence of output by parts.
4321 # TEST: is the test message to be printed with the test success/fail.
4322 # SENTINEL: Is the terminal pattern indicating that output has finished.
4323 # LIST: is the sequence of outputs to match.
4324 # If the sentinel is recognized early, it is considered an error.
4327 # 1 if the test failed,
4328 # 0 if the test passes,
4329 # -1 if there was an internal error.
4331 proc gdb_expect_list {test sentinel list} {
4333 global suppress_flag
4336 if { $suppress_flag } {
4338 unresolved "${test}"
4340 while { ${index} < [llength ${list}] } {
4341 set pattern [lindex ${list} ${index}]
4342 set index [expr ${index} + 1]
4343 verbose -log "gdb_expect_list pattern: /$pattern/" 2
4344 if { ${index} == [llength ${list}] } {
4347 -re "${pattern}${sentinel}" {
4348 # pass "${test}, pattern ${index} + sentinel"
4351 fail "${test} (pattern ${index} + sentinel)"
4354 -re ".*A problem internal to GDB has been detected" {
4355 fail "${test} (GDB internal error)"
4357 gdb_internal_error_resync
4360 fail "${test} (pattern ${index} + sentinel) (timeout)"
4365 # unresolved "${test}, pattern ${index} + sentinel"
4371 # pass "${test}, pattern ${index}"
4374 fail "${test} (pattern ${index})"
4377 -re ".*A problem internal to GDB has been detected" {
4378 fail "${test} (GDB internal error)"
4380 gdb_internal_error_resync
4383 fail "${test} (pattern ${index}) (timeout)"
4388 # unresolved "${test}, pattern ${index}"
4402 proc gdb_suppress_entire_file { reason } {
4403 global suppress_flag
4406 set suppress_flag -1
4410 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4411 # gdb_expect to fail immediately (until the next call to
4412 # gdb_stop_suppressing_tests).
4414 proc gdb_suppress_tests { args } {
4415 global suppress_flag
4417 return; # fnf - disable pending review of results where
4418 # testsuite ran better without this
4421 if { $suppress_flag == 1 } {
4422 if { [llength $args] > 0 } {
4423 warning "[lindex $args 0]\n"
4425 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4431 # Clear suppress_flag.
4433 proc gdb_stop_suppressing_tests { } {
4434 global suppress_flag
4436 if [info exists suppress_flag] {
4437 if { $suppress_flag > 0 } {
4439 clone_output "Tests restarted.\n"
4446 proc gdb_clear_suppressed { } {
4447 global suppress_flag
4452 # Spawn the gdb process.
4454 # This doesn't expect any output or do any other initialization,
4455 # leaving those to the caller.
4457 # Overridable function -- you can override this function in your
4460 proc gdb_spawn { } {
4464 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4466 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
4469 set saved_gdbflags $GDBFLAGS
4471 if {$GDBFLAGS != ""} {
4474 append GDBFLAGS $cmdline_flags
4478 set GDBFLAGS $saved_gdbflags
4483 # Start gdb running, wait for prompt, and disable the pagers.
4485 # Overridable function -- you can override this function in your
4488 proc gdb_start { } {
4493 catch default_gdb_exit
4496 # Return true if we can spawn a program on the target and attach to
4499 proc can_spawn_for_attach { } {
4500 # We use exp_pid to get the inferior's pid, assuming that gives
4501 # back the pid of the program. On remote boards, that would give
4502 # us instead the PID of e.g., the ssh client, etc.
4503 if [is_remote target] then {
4507 # The "attach" command doesn't make sense when the target is
4508 # stub-like, where GDB finds the program already started on
4509 # initial connection.
4510 if {[target_info exists use_gdb_stub]} {
4518 # Kill a progress previously started with spawn_wait_for_attach, and
4519 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4522 proc kill_wait_spawned_process { proc_spawn_id } {
4523 set pid [exp_pid -i $proc_spawn_id]
4525 verbose -log "killing ${pid}"
4526 remote_exec build "kill -9 ${pid}"
4528 verbose -log "closing ${proc_spawn_id}"
4529 catch "close -i $proc_spawn_id"
4530 verbose -log "waiting for ${proc_spawn_id}"
4532 # If somehow GDB ends up still attached to the process here, a
4533 # blocking wait hangs until gdb is killed (or until gdb / the
4534 # ptracer reaps the exit status too, but that won't happen because
4535 # something went wrong.) Passing -nowait makes expect tell Tcl to
4536 # wait for the PID in the background. That's fine because we
4537 # don't care about the exit status. */
4538 wait -nowait -i $proc_spawn_id
4541 # Returns the process id corresponding to the given spawn id.
4543 proc spawn_id_get_pid { spawn_id } {
4544 set testpid [exp_pid -i $spawn_id]
4546 if { [istarget "*-*-cygwin*"] } {
4547 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4548 # might be different due to the way fork/exec works.
4549 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4555 # Start a set of programs running and then wait for a bit, to be sure
4556 # that they can be attached to. Return a list of processes spawn IDs,
4557 # one element for each process spawned. It's a test error to call
4558 # this when [can_spawn_for_attach] is false.
4560 proc spawn_wait_for_attach { executable_list } {
4561 set spawn_id_list {}
4563 if ![can_spawn_for_attach] {
4564 # The caller should have checked can_spawn_for_attach itself
4565 # before getting here.
4566 error "can't spawn for attach with this target/board"
4569 foreach {executable} $executable_list {
4570 # Note we use Expect's spawn, not Tcl's exec, because with
4571 # spawn we control when to wait for/reap the process. That
4572 # allows killing the process by PID without being subject to
4574 lappend spawn_id_list [remote_spawn target $executable]
4579 return $spawn_id_list
4583 # gdb_load_cmd -- load a file into the debugger.
4584 # ARGS - additional args to load command.
4585 # return a -1 if anything goes wrong.
4587 proc gdb_load_cmd { args } {
4590 if [target_info exists gdb_load_timeout] {
4591 set loadtimeout [target_info gdb_load_timeout]
4593 set loadtimeout 1600
4595 send_gdb "load $args\n"
4596 verbose "Timeout is now $loadtimeout seconds" 2
4597 gdb_expect $loadtimeout {
4598 -re "Loading section\[^\r\]*\r\n" {
4601 -re "Start address\[\r\]*\r\n" {
4604 -re "Transfer rate\[\r\]*\r\n" {
4607 -re "Memory access error\[^\r\]*\r\n" {
4608 perror "Failed to load program"
4611 -re "$gdb_prompt $" {
4614 -re "(.*)\r\n$gdb_prompt " {
4615 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4619 perror "Timed out trying to load $args."
4626 # Invoke "gcore". CORE is the name of the core file to write. TEST
4627 # is the name of the test case. This will return 1 if the core file
4628 # was created, 0 otherwise. If this fails to make a core file because
4629 # this configuration of gdb does not support making core files, it
4630 # will call "unsupported", not "fail". However, if this fails to make
4631 # a core file for some other reason, then it will call "fail".
4633 proc gdb_gcore_cmd {core test} {
4637 gdb_test_multiple "gcore $core" $test {
4638 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
4642 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4650 # Load core file CORE. TEST is the name of the test case.
4651 # This will record a pass/fail for loading the core file.
4653 # 1 - core file is successfully loaded
4654 # 0 - core file loaded but has a non fatal error
4655 # -1 - core file failed to load
4657 proc gdb_core_cmd { core test } {
4660 gdb_test_multiple "core $core" "$test" {
4661 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
4664 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4665 fail "$test (bad file format)"
4668 -re -wrap "[string_to_regexp $core]: No such file or directory.*" {
4669 fail "$test (file not found)"
4672 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4673 fail "$test (incomplete note section)"
4676 -re "Core was generated by .*\r\n$gdb_prompt $" {
4680 -re ".*$gdb_prompt $" {
4685 fail "$test (timeout)"
4689 fail "unsupported output from 'core' command"
4693 # Return the filename to download to the target and load on the target
4694 # for this shared library. Normally just LIBNAME, unless shared libraries
4695 # for this target have separate link and load images.
4697 proc shlib_target_file { libname } {
4701 # Return the filename GDB will load symbols from when debugging this
4702 # shared library. Normally just LIBNAME, unless shared libraries for
4703 # this target have separate link and load images.
4705 proc shlib_symbol_file { libname } {
4709 # Return the filename to download to the target and load for this
4710 # executable. Normally just BINFILE unless it is renamed to something
4711 # else for this target.
4713 proc exec_target_file { binfile } {
4717 # Return the filename GDB will load symbols from when debugging this
4718 # executable. Normally just BINFILE unless executables for this target
4719 # have separate files for symbols.
4721 proc exec_symbol_file { binfile } {
4725 # Rename the executable file. Normally this is just BINFILE1 being renamed
4726 # to BINFILE2, but some targets require multiple binary files.
4727 proc gdb_rename_execfile { binfile1 binfile2 } {
4728 file rename -force [exec_target_file ${binfile1}] \
4729 [exec_target_file ${binfile2}]
4730 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
4731 file rename -force [exec_symbol_file ${binfile1}] \
4732 [exec_symbol_file ${binfile2}]
4736 # "Touch" the executable file to update the date. Normally this is just
4737 # BINFILE, but some targets require multiple files.
4738 proc gdb_touch_execfile { binfile } {
4739 set time [clock seconds]
4740 file mtime [exec_target_file ${binfile}] $time
4741 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
4742 file mtime [exec_symbol_file ${binfile}] $time
4746 # Like remote_download but provides a gdb-specific behavior.
4748 # If the destination board is remote, the local file FROMFILE is transferred as
4749 # usual with remote_download to TOFILE on the remote board. The destination
4750 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4753 # If the destination board is local, the destination path TOFILE is passed
4754 # through standard_output_file, and FROMFILE is copied there.
4756 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
4759 proc gdb_remote_download {dest fromfile {tofile {}}} {
4760 # If TOFILE is not given, default to the same filename as FROMFILE.
4761 if {[string length $tofile] == 0} {
4762 set tofile [file tail $fromfile]
4765 if {[is_remote $dest]} {
4766 # When the DEST is remote, we simply send the file to DEST.
4769 set destname [remote_download $dest $fromfile $tofile]
4770 lappend cleanfiles $destname
4774 # When the DEST is local, we copy the file to the test directory (where
4775 # the executable is).
4777 # Note that we pass TOFILE through standard_output_file, regardless of
4778 # whether it is absolute or relative, because we don't want the tests
4779 # to be able to write outside their standard output directory.
4781 set tofile [standard_output_file $tofile]
4783 file copy -force $fromfile $tofile
4789 # gdb_load_shlib LIB...
4791 # Copy the listed library to the target.
4793 proc gdb_load_shlib { file } {
4796 if ![info exists gdb_spawn_id] {
4797 perror "gdb_load_shlib: GDB is not running"
4800 set dest [gdb_remote_download target [shlib_target_file $file]]
4802 if {[is_remote target]} {
4803 # If the target is remote, we need to tell gdb where to find the
4806 # We could set this even when not testing remotely, but a user
4807 # generally won't set it unless necessary. In order to make the tests
4808 # more like the real-life scenarios, we don't set it for local testing.
4809 gdb_test "set solib-search-path [file dirname $file]" "" ""
4816 # gdb_load -- load a file into the debugger. Specifying no file
4817 # defaults to the executable currently being debugged.
4818 # The return value is 0 for success, -1 for failure.
4819 # Many files in config/*.exp override this procedure.
4821 proc gdb_load { arg } {
4823 return [gdb_file_cmd $arg]
4828 # gdb_reload -- load a file into the target. Called before "running",
4829 # either the first time or after already starting the program once,
4830 # for remote targets. Most files that override gdb_load should now
4831 # override this instead.
4833 # INFERIOR_ARGS contains the arguments to pass to the inferiors, as a
4834 # single string to get interpreted by a shell. If the target board
4835 # overriding gdb_reload is a "stub", then it should arrange things such
4836 # these arguments make their way to the inferior process.
4838 proc gdb_reload { {inferior_args {}} } {
4839 # For the benefit of existing configurations, default to gdb_load.
4840 # Specifying no file defaults to the executable currently being
4842 return [gdb_load ""]
4845 proc gdb_continue { function } {
4848 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4851 proc default_gdb_init { test_file_name } {
4852 global gdb_wrapper_initialized
4853 global gdb_wrapper_target
4854 global gdb_test_file_name
4860 gdb_clear_suppressed
4862 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4864 # Make sure that the wrapper is rebuilt
4865 # with the appropriate multilib option.
4866 if { $gdb_wrapper_target != [current_target_name] } {
4867 set gdb_wrapper_initialized 0
4870 # Unlike most tests, we have a small number of tests that generate
4871 # a very large amount of output. We therefore increase the expect
4872 # buffer size to be able to contain the entire test output. This
4873 # is especially needed by gdb.base/info-macros.exp.
4875 # Also set this value for the currently running GDB.
4876 match_max [match_max -d]
4878 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4879 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4882 if [target_info exists gdb_prompt] {
4883 set gdb_prompt [target_info gdb_prompt]
4885 set gdb_prompt "\\(gdb\\)"
4888 if [info exists use_gdb_stub] {
4893 # Return a path using GDB_PARALLEL.
4894 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4895 # GDB_PARALLEL must be defined, the caller must check.
4897 # The default value for GDB_PARALLEL is, canonically, ".".
4898 # The catch is that tests don't expect an additional "./" in file paths so
4899 # omit any directory for the default case.
4900 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4901 # its special handling.
4903 proc make_gdb_parallel_path { args } {
4904 global GDB_PARALLEL objdir
4905 set joiner [list "file" "join" $objdir]
4906 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
4907 lappend joiner $GDB_PARALLEL
4909 set joiner [concat $joiner $args]
4910 return [eval $joiner]
4913 # Turn BASENAME into a full file name in the standard output
4914 # directory. It is ok if BASENAME is the empty string; in this case
4915 # the directory is returned.
4917 proc standard_output_file {basename} {
4918 global objdir subdir gdb_test_file_name
4920 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
4922 # If running on MinGW, replace /c/foo with c:/foo
4923 if { [ishost *-*-mingw*] } {
4924 set dir [exec sh -c "cd ${dir} && pwd -W"]
4926 return [file join $dir $basename]
4929 # Turn BASENAME into a full file name in the standard output directory. If
4930 # GDB has been launched more than once then append the count, starting with
4933 proc standard_output_file_with_gdb_instance {basename} {
4934 global gdb_instances
4935 set count [expr $gdb_instances - 1 ]
4938 return [standard_output_file $basename]
4940 return [standard_output_file ${basename}.${count}]
4943 # Return the name of a file in our standard temporary directory.
4945 proc standard_temp_file {basename} {
4946 # Since a particular runtest invocation is only executing a single test
4947 # file at any given time, we can use the runtest pid to build the
4948 # path of the temp directory.
4949 set dir [make_gdb_parallel_path temp [pid]]
4951 return [file join $dir $basename]
4954 # Rename file A to file B, if B does not already exists. Otherwise, leave B
4955 # as is and delete A. Return 1 if rename happened.
4957 proc tentative_rename { a b } {
4958 global errorInfo errorCode
4959 set code [catch {file rename -- $a $b} result]
4960 if { $code == 1 && [lindex $errorCode 0] == "POSIX" \
4961 && [lindex $errorCode 1] == "EEXIST" } {
4966 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
4967 } elseif {$code > 1} {
4968 return -code $code $result
4973 # Create a file with name FILENAME and contents TXT in the cache directory.
4974 # If EXECUTABLE, mark the new file for execution.
4976 proc cached_file { filename txt {executable 0}} {
4977 set filename [make_gdb_parallel_path cache $filename]
4979 if { [file exists $filename] } {
4983 set dir [file dirname $filename]
4986 set tmp_filename $filename.[pid]
4987 set fd [open $tmp_filename w]
4991 if { $executable } {
4992 exec chmod +x $tmp_filename
4994 tentative_rename $tmp_filename $filename
4999 # Set 'testfile', 'srcfile', and 'binfile'.
5001 # ARGS is a list of source file specifications.
5002 # Without any arguments, the .exp file's base name is used to
5003 # compute the source file name. The ".c" extension is added in this case.
5004 # If ARGS is not empty, each entry is a source file specification.
5005 # If the specification starts with a ".", it is treated as a suffix
5006 # to append to the .exp file's base name.
5007 # If the specification is the empty string, it is treated as if it
5009 # Otherwise it is a file name.
5010 # The first file in the list is used to set the 'srcfile' global.
5011 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
5013 # Most tests should call this without arguments.
5015 # If a completely different binary file name is needed, then it
5016 # should be handled in the .exp file with a suitable comment.
5018 proc standard_testfile {args} {
5019 global gdb_test_file_name
5021 global gdb_test_file_last_vars
5024 global testfile binfile
5026 set testfile $gdb_test_file_name
5027 set binfile [standard_output_file ${testfile}]
5029 if {[llength $args] == 0} {
5033 # Unset our previous output variables.
5034 # This can help catch hidden bugs.
5035 if {[info exists gdb_test_file_last_vars]} {
5036 foreach varname $gdb_test_file_last_vars {
5038 catch {unset $varname}
5041 # 'executable' is often set by tests.
5042 set gdb_test_file_last_vars {executable}
5046 set varname srcfile$suffix
5049 # Handle an extension.
5052 } elseif {[string range $arg 0 0] == "."} {
5053 set arg $testfile$arg
5057 lappend gdb_test_file_last_vars $varname
5059 if {$suffix == ""} {
5067 # The default timeout used when testing GDB commands. We want to use
5068 # the same timeout as the default dejagnu timeout, unless the user has
5069 # already provided a specific value (probably through a site.exp file).
5070 global gdb_test_timeout
5071 if ![info exists gdb_test_timeout] {
5072 set gdb_test_timeout $timeout
5075 # A list of global variables that GDB testcases should not use.
5076 # We try to prevent their use by monitoring write accesses and raising
5077 # an error when that happens.
5078 set banned_variables { bug_id prms_id }
5080 # A list of procedures that GDB testcases should not use.
5081 # We try to prevent their use by monitoring invocations and raising
5082 # an error when that happens.
5083 set banned_procedures { strace }
5085 # gdb_init is called by runtest at start, but also by several
5086 # tests directly; gdb_finish is only called from within runtest after
5087 # each test source execution.
5088 # Placing several traces by repetitive calls to gdb_init leads
5089 # to problems, as only one trace is removed in gdb_finish.
5090 # To overcome this possible problem, we add a variable that records
5091 # if the banned variables and procedures are already traced.
5094 proc gdb_init { test_file_name } {
5095 # Reset the timeout value to the default. This way, any testcase
5096 # that changes the timeout value without resetting it cannot affect
5097 # the timeout used in subsequent testcases.
5098 global gdb_test_timeout
5100 set timeout $gdb_test_timeout
5102 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
5103 && [target_info exists gdb_reverse_timeout] } {
5104 set timeout [target_info gdb_reverse_timeout]
5107 # If GDB_INOTIFY is given, check for writes to '.'. This is a
5108 # debugging tool to help confirm that the test suite is
5109 # parallel-safe. You need "inotifywait" from the
5110 # inotify-tools package to use this.
5111 global GDB_INOTIFY inotify_pid
5112 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
5113 global outdir tool inotify_log_file
5115 set exclusions {outputs temp gdb[.](log|sum) cache}
5116 set exclusion_re ([join $exclusions |])
5118 set inotify_log_file [standard_temp_file inotify.out]
5119 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
5120 --exclude $exclusion_re \
5121 |& tee -a $outdir/$tool.log $inotify_log_file &]
5123 # Wait for the watches; hopefully this is long enough.
5126 # Clear the log so that we don't emit a warning the first time
5128 set fd [open $inotify_log_file w]
5132 # Block writes to all banned variables, and invocation of all
5133 # banned procedures...
5134 global banned_variables
5135 global banned_procedures
5136 global banned_traced
5137 if (!$banned_traced) {
5138 foreach banned_var $banned_variables {
5139 global "$banned_var"
5140 trace add variable "$banned_var" write error
5142 foreach banned_proc $banned_procedures {
5143 global "$banned_proc"
5144 trace add execution "$banned_proc" enter error
5149 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
5150 # messages as expected.
5155 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
5156 # the test results. Even if /dev/null doesn't exist on the particular
5157 # platform, the readline library will use the default setting just by
5158 # failing to open the file. OTOH, opening /dev/null successfully will
5159 # also result in the default settings being used since nothing will be
5160 # read from this file.
5161 setenv INPUTRC "/dev/null"
5163 # This disables style output, which would interfere with many
5167 # Ensure that GDBHISTFILE and GDBHISTSIZE are removed from the
5168 # environment, we don't want these modifications to the history
5170 unset -nocomplain ::env(GDBHISTFILE)
5171 unset -nocomplain ::env(GDBHISTSIZE)
5173 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
5174 # during startup. See "man expect" for details about stty_init.
5176 set stty_init "rows 25 cols 80"
5178 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
5179 # grep. Clear GREP_OPTIONS to make the behavior predictable,
5180 # especially having color output turned on can cause tests to fail.
5181 setenv GREP_OPTIONS ""
5183 # Clear $gdbserver_reconnect_p.
5184 global gdbserver_reconnect_p
5185 set gdbserver_reconnect_p 1
5186 unset gdbserver_reconnect_p
5188 # Clear $last_loaded_file
5189 global last_loaded_file
5190 unset -nocomplain last_loaded_file
5192 # Reset GDB number of instances
5193 global gdb_instances
5196 return [default_gdb_init $test_file_name]
5199 proc gdb_finish { } {
5200 global gdbserver_reconnect_p
5204 # Exit first, so that the files are no longer in use.
5207 if { [llength $cleanfiles] > 0 } {
5208 eval remote_file target delete $cleanfiles
5212 # Unblock write access to the banned variables. Dejagnu typically
5213 # resets some of them between testcases.
5214 global banned_variables
5215 global banned_procedures
5216 global banned_traced
5217 if ($banned_traced) {
5218 foreach banned_var $banned_variables {
5219 global "$banned_var"
5220 trace remove variable "$banned_var" write error
5222 foreach banned_proc $banned_procedures {
5223 global "$banned_proc"
5224 trace remove execution "$banned_proc" enter error
5231 set debug_format "unknown"
5233 # Run the gdb command "info source" and extract the debugging format
5234 # information from the output and save it in debug_format.
5236 proc get_debug_format { } {
5241 set debug_format "unknown"
5242 send_gdb "info source\n"
5244 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
5245 set debug_format $expect_out(1,string)
5246 verbose "debug format is $debug_format"
5249 -re "No current source file.\r\n$gdb_prompt $" {
5250 perror "get_debug_format used when no current source file"
5253 -re "$gdb_prompt $" {
5254 warning "couldn't check debug format (no valid response)."
5258 warning "couldn't check debug format (timeout)."
5264 # Return true if FORMAT matches the debug format the current test was
5265 # compiled with. FORMAT is a shell-style globbing pattern; it can use
5266 # `*', `[...]', and so on.
5268 # This function depends on variables set by `get_debug_format', above.
5270 proc test_debug_format {format} {
5273 return [expr [string match $format $debug_format] != 0]
5276 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
5277 # COFF, stabs, etc). If that format matches the format that the
5278 # current test was compiled with, then the next test is expected to
5279 # fail for any target. Returns 1 if the next test or set of tests is
5280 # expected to fail, 0 otherwise (or if it is unknown). Must have
5281 # previously called get_debug_format.
5282 proc setup_xfail_format { format } {
5283 set ret [test_debug_format $format]
5291 # gdb_get_line_number TEXT [FILE]
5293 # Search the source file FILE, and return the line number of the
5294 # first line containing TEXT. If no match is found, an error is thrown.
5296 # TEXT is a string literal, not a regular expression.
5298 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
5299 # specified, and does not start with "/", then it is assumed to be in
5300 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
5301 # by changing the callers and the interface at the same time.
5302 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
5303 # gdb.base/ena-dis-br.exp.
5305 # Use this function to keep your test scripts independent of the
5306 # exact line numbering of the source file. Don't write:
5308 # send_gdb "break 20"
5310 # This means that if anyone ever edits your test's source file,
5311 # your test could break. Instead, put a comment like this on the
5312 # source file line you want to break at:
5314 # /* breakpoint spot: frotz.exp: test name */
5316 # and then write, in your test script (which we assume is named
5319 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
5321 # (Yes, Tcl knows how to handle the nested quotes and brackets.
5324 # % puts "foo [lindex "bar baz" 1]"
5327 # Tcl is quite clever, for a little stringy language.)
5331 # The previous implementation of this procedure used the gdb search command.
5332 # This version is different:
5334 # . It works with MI, and it also works when gdb is not running.
5336 # . It operates on the build machine, not the host machine.
5338 # . For now, this implementation fakes a current directory of
5339 # $srcdir/$subdir to be compatible with the old implementation.
5340 # This will go away eventually and some callers will need to
5343 # . The TEXT argument is literal text and matches literally,
5344 # not a regular expression as it was before.
5346 # . State changes in gdb, such as changing the current file
5347 # and setting $_, no longer happen.
5349 # After a bit of time we can forget about the differences from the
5350 # old implementation.
5352 # --chastain 2004-08-05
5354 proc gdb_get_line_number { text { file "" } } {
5359 if { "$file" == "" } then {
5362 if { ! [regexp "^/" "$file"] } then {
5363 set file "$srcdir/$subdir/$file"
5366 if { [ catch { set fd [open "$file"] } message ] } then {
5371 for { set line 1 } { 1 } { incr line } {
5372 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
5375 if { $nchar < 0 } then {
5378 if { [string first "$text" "$body"] >= 0 } then {
5384 if { [ catch { close "$fd" } message ] } then {
5389 error "undefined tag \"$text\""
5395 # Continue the program until it ends.
5397 # MSSG is the error message that gets printed. If not given, a
5399 # COMMAND is the command to invoke. If not given, "continue" is
5401 # ALLOW_EXTRA is a flag indicating whether the test should expect
5402 # extra output between the "Continuing." line and the program
5403 # exiting. By default it is zero; if nonzero, any extra output
5406 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
5407 global inferior_exited_re use_gdb_stub
5410 set text "continue until exit"
5412 set text "continue until exit at $mssg"
5420 # By default, we don't rely on exit() behavior of remote stubs --
5421 # it's common for exit() to be implemented as a simple infinite
5422 # loop, or a forced crash/reset. For native targets, by default, we
5423 # assume process exit is reported as such. If a non-reliable target
5424 # is used, we set a breakpoint at exit, and continue to that.
5425 if { [target_info exists exit_is_reliable] } {
5426 set exit_is_reliable [target_info exit_is_reliable]
5428 set exit_is_reliable [expr ! $use_gdb_stub]
5431 if { ! $exit_is_reliable } {
5432 if {![gdb_breakpoint "exit"]} {
5435 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
5438 # Continue until we exit. Should not stop again.
5439 # Don't bother to check the output of the program, that may be
5440 # extremely tough for some remote systems.
5442 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5447 proc rerun_to_main {} {
5448 global gdb_prompt use_gdb_stub
5453 -re ".*Breakpoint .*main .*$gdb_prompt $"\
5454 {pass "rerun to main" ; return 0}
5455 -re "$gdb_prompt $"\
5456 {fail "rerun to main" ; return 0}
5457 timeout {fail "(timeout) rerun to main" ; return 0}
5462 -re "The program .* has been started already.*y or n. $" {
5463 send_gdb "y\n" answer
5466 -re "Starting program.*$gdb_prompt $"\
5467 {pass "rerun to main" ; return 0}
5468 -re "$gdb_prompt $"\
5469 {fail "rerun to main" ; return 0}
5470 timeout {fail "(timeout) rerun to main" ; return 0}
5475 # Return true if EXECUTABLE contains a .gdb_index or .debug_names index section.
5477 proc exec_has_index_section { executable } {
5478 set readelf_program [gdb_find_readelf]
5479 set res [catch {exec $readelf_program -S $executable \
5480 | grep -E "\.gdb_index|\.debug_names" }]
5487 # Return list with major and minor version of readelf, or an empty list.
5488 gdb_caching_proc readelf_version {
5489 set readelf_program [gdb_find_readelf]
5490 set res [catch {exec $readelf_program --version} output]
5494 set lines [split $output \n]
5495 set line [lindex $lines 0]
5496 set res [regexp {[ \t]+([0-9]+)[.]([0-9]+)[^ \t]*$} \
5497 $line dummy major minor]
5501 return [list $major $minor]
5504 # Return 1 if readelf prints the PIE flag, 0 if is doesn't, and -1 if unknown.
5505 proc readelf_prints_pie { } {
5506 set version [readelf_version]
5507 if { [llength $version] == 0 } {
5510 set major [lindex $version 0]
5511 set minor [lindex $version 1]
5512 # It would be better to construct a PIE executable and test if the PIE
5513 # flag is printed by readelf, but we cannot reliably construct a PIE
5514 # executable if the multilib_flags dictate otherwise
5515 # (--target_board=unix/-no-pie/-fno-PIE).
5516 return [version_at_least $major $minor 2 26]
5519 # Return 1 if EXECUTABLE is a Position Independent Executable, 0 if it is not,
5520 # and -1 if unknown.
5522 proc exec_is_pie { executable } {
5523 set res [readelf_prints_pie]
5527 set readelf_program [gdb_find_readelf]
5528 # We're not testing readelf -d | grep "FLAGS_1.*Flags:.*PIE"
5529 # because the PIE flag is not set by all versions of gold, see PR
5531 set res [catch {exec $readelf_program -h $executable} output]
5535 set res [regexp -line {^[ \t]*Type:[ \t]*DYN \(Shared object file\)$} \
5543 # Return true if a test should be skipped due to lack of floating
5544 # point support or GDB can't fetch the contents from floating point
5547 gdb_caching_proc gdb_skip_float_test {
5548 if [target_info exists gdb,skip_float_tests] {
5552 # There is an ARM kernel ptrace bug that hardware VFP registers
5553 # are not updated after GDB ptrace set VFP registers. The bug
5554 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5555 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5556 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5557 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5558 # This kernel bug is detected by check how does GDB change the
5559 # program result by changing one VFP register.
5560 if { [istarget "arm*-*-linux*"] } {
5562 set compile_flags {debug nowarnings }
5564 # Set up, compile, and execute a test program having VFP
5566 set src [standard_temp_file arm_vfp[pid].c]
5567 set exe [standard_temp_file arm_vfp[pid].x]
5569 gdb_produce_source $src {
5574 asm ("vldr d0, [%0]" : : "r" (&d));
5575 asm ("vldr d1, [%0]" : : "r" (&d));
5576 asm (".global break_here\n"
5578 asm ("vcmp.f64 d0, d1\n"
5579 "vmrs APSR_nzcv, fpscr\n"
5580 "bne L_value_different\n"
5583 "L_value_different:\n"
5585 "L_end:\n" : "=r" (ret) :);
5587 /* Return $d0 != $d1. */
5592 verbose "compiling testfile $src" 2
5593 set lines [gdb_compile $src $exe executable $compile_flags]
5596 if ![string match "" $lines] then {
5597 verbose "testfile compilation failed, returning 1" 2
5601 # No error message, compilation succeeded so now run it via gdb.
5602 # Run the test up to 5 times to detect whether ptrace can
5603 # correctly update VFP registers or not.
5605 for {set i 0} {$i < 5} {incr i} {
5606 global gdb_prompt srcdir subdir
5610 gdb_reinitialize_dir $srcdir/$subdir
5614 gdb_test "break *break_here"
5615 gdb_continue_to_breakpoint "break_here"
5617 # Modify $d0 to a different value, so the exit code should
5619 gdb_test "set \$d0 = 5.0"
5621 set test "continue to exit"
5622 gdb_test_multiple "continue" "$test" {
5623 -re "exited with code 01.*$gdb_prompt $" {
5625 -re "exited normally.*$gdb_prompt $" {
5626 # However, the exit code is 0. That means something
5627 # wrong in setting VFP registers.
5635 remote_file build delete $exe
5637 return $skip_vfp_test
5642 # Print a message and return true if a test should be skipped
5643 # due to lack of stdio support.
5645 proc gdb_skip_stdio_test { msg } {
5646 if [target_info exists gdb,noinferiorio] {
5647 verbose "Skipping test '$msg': no inferior i/o."
5653 proc gdb_skip_bogus_test { msg } {
5657 # Return true if a test should be skipped due to lack of XML support
5659 # NOTE: This must be called while gdb is *not* running.
5661 gdb_caching_proc gdb_skip_xml_test {
5666 if { [info exists gdb_spawn_id] } {
5667 error "GDB must not be running in gdb_skip_xml_tests."
5670 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5674 gdb_test_multiple "set tdesc filename $xml_file" "" {
5675 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5678 -re ".*$gdb_prompt $" { }
5684 # Return true if argv[0] is available.
5686 gdb_caching_proc gdb_has_argv0 {
5689 # Compile and execute a test program to check whether argv[0] is available.
5690 gdb_simple_compile has_argv0 {
5691 int main (int argc, char **argv) {
5698 proc gdb_has_argv0_1 { exe } {
5699 global srcdir subdir
5700 global gdb_prompt hex
5704 gdb_reinitialize_dir $srcdir/$subdir
5707 # Set breakpoint on main.
5708 gdb_test_multiple "break main" "break main" {
5709 -re "Breakpoint.*${gdb_prompt} $" {
5711 -re "${gdb_prompt} $" {
5718 gdb_test_multiple "" "run to main" {
5719 -re "Breakpoint.*${gdb_prompt} $" {
5721 -re "${gdb_prompt} $" {
5726 set old_elements "200"
5727 set test "show print elements"
5728 gdb_test_multiple $test $test {
5729 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5730 set old_elements $expect_out(1,string)
5733 set old_repeats "200"
5734 set test "show print repeats"
5735 gdb_test_multiple $test $test {
5736 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
5737 set old_repeats $expect_out(1,string)
5740 gdb_test_no_output "set print elements unlimited" ""
5741 gdb_test_no_output "set print repeats unlimited" ""
5744 # Check whether argc is 1.
5745 gdb_test_multiple "p argc" "p argc" {
5746 -re " = 1\r\n${gdb_prompt} $" {
5748 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5749 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
5752 -re "${gdb_prompt} $" {
5756 -re "${gdb_prompt} $" {
5760 gdb_test_no_output "set print elements $old_elements" ""
5761 gdb_test_no_output "set print repeats $old_repeats" ""
5766 set result [gdb_has_argv0_1 $obj]
5772 && ([istarget *-*-linux*]
5773 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5774 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5775 || [istarget *-*-openbsd*]
5776 || [istarget *-*-darwin*]
5777 || [istarget *-*-solaris*]
5778 || [istarget *-*-aix*]
5779 || [istarget *-*-gnu*]
5780 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5781 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5782 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5783 || [istarget *-*-symbianelf*]
5784 || [istarget *-*-osf*]
5785 || [istarget *-*-dicos*]
5786 || [istarget *-*-nto*]
5787 || [istarget *-*-*vms*]
5788 || [istarget *-*-lynx*178]) } {
5789 fail "argv\[0\] should be available on this target"
5795 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5796 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5797 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5798 # the name of a debuginfo only file. This file will be stored in the same
5801 # Functions for separate debug info testing
5803 # starting with an executable:
5804 # foo --> original executable
5806 # at the end of the process we have:
5807 # foo.stripped --> foo w/o debug info
5808 # foo.debug --> foo's debug info
5809 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
5811 # Fetch the build id from the file.
5812 # Returns "" if there is none.
5814 proc get_build_id { filename } {
5815 if { ([istarget "*-*-mingw*"]
5816 || [istarget *-*-cygwin*]) } {
5817 set objdump_program [gdb_find_objdump]
5818 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5819 verbose "result is $result"
5820 verbose "output is $output"
5826 set tmp [standard_output_file "${filename}-tmp"]
5827 set objcopy_program [gdb_find_objcopy]
5828 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5829 verbose "result is $result"
5830 verbose "output is $output"
5835 fconfigure $fi -translation binary
5836 # Skip the NOTE header.
5841 if ![string compare $data ""] then {
5844 # Convert it to hex.
5845 binary scan $data H* data
5850 # Return the build-id hex string (usually 160 bits as 40 hex characters)
5851 # converted to the form: .build-id/ab/cdef1234...89.debug
5852 # Return "" if no build-id found.
5853 proc build_id_debug_filename_get { filename } {
5854 set data [get_build_id $filename]
5855 if { $data == "" } {
5858 regsub {^..} $data {\0/} data
5859 return ".build-id/${data}.debug"
5862 # Create stripped files for DEST, replacing it. If ARGS is passed, it is a
5863 # list of optional flags. The only currently supported flag is no-main,
5864 # which removes the symbol entry for main from the separate debug file.
5866 # Function returns zero on success. Function will return non-zero failure code
5867 # on some targets not supporting separate debug info (such as i386-msdos).
5869 proc gdb_gnu_strip_debug { dest args } {
5871 # Use the first separate debug info file location searched by GDB so the
5872 # run cannot be broken by some stale file searched with higher precedence.
5873 set debug_file "${dest}.debug"
5875 set strip_to_file_program [transform strip]
5876 set objcopy_program [gdb_find_objcopy]
5878 set debug_link [file tail $debug_file]
5879 set stripped_file "${dest}.stripped"
5881 # Get rid of the debug info, and store result in stripped_file
5882 # something like gdb/testsuite/gdb.base/blah.stripped.
5883 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5884 verbose "result is $result"
5885 verbose "output is $output"
5890 # Workaround PR binutils/10802:
5891 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5892 set perm [file attributes ${dest} -permissions]
5893 file attributes ${stripped_file} -permissions $perm
5895 # Get rid of everything but the debug info, and store result in debug_file
5896 # This will be in the .debug subdirectory, see above.
5897 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5898 verbose "result is $result"
5899 verbose "output is $output"
5904 # If no-main is passed, strip the symbol for main from the separate
5905 # file. This is to simulate the behavior of elfutils's eu-strip, which
5906 # leaves the symtab in the original file only. There's no way to get
5907 # objcopy or strip to remove the symbol table without also removing the
5908 # debugging sections, so this is as close as we can get.
5909 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
5910 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
5911 verbose "result is $result"
5912 verbose "output is $output"
5916 file delete "${debug_file}"
5917 file rename "${debug_file}-tmp" "${debug_file}"
5920 # Link the two previous output files together, adding the .gnu_debuglink
5921 # section to the stripped_file, containing a pointer to the debug_file,
5922 # save the new file in dest.
5923 # This will be the regular executable filename, in the usual location.
5924 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5925 verbose "result is $result"
5926 verbose "output is $output"
5931 # Workaround PR binutils/10802:
5932 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
5933 set perm [file attributes ${stripped_file} -permissions]
5934 file attributes ${dest} -permissions $perm
5939 # Test the output of GDB_COMMAND matches the pattern obtained
5940 # by concatenating all elements of EXPECTED_LINES. This makes
5941 # it possible to split otherwise very long string into pieces.
5942 # If third argument TESTNAME is not empty, it's used as the name of the
5943 # test to be printed on pass/fail.
5944 proc help_test_raw { gdb_command expected_lines {testname {}} } {
5945 set expected_output [join $expected_lines ""]
5946 if {$testname != {}} {
5947 gdb_test "${gdb_command}" "${expected_output}" $testname
5951 gdb_test "${gdb_command}" "${expected_output}"
5954 # A regexp that matches the end of help CLASS|PREFIX_COMMAND
5955 set help_list_trailer {
5956 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5957 "Type \"apropos -v word\" for full documentation of commands related to \"word\"\.[\r\n]+"
5958 "Command name abbreviations are allowed if unambiguous\."
5961 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5962 # are regular expressions that should match the beginning of output,
5963 # before the list of commands in that class.
5964 # LIST_OF_COMMANDS are regular expressions that should match the
5965 # list of commands in that class. If empty, the command list will be
5966 # matched automatically. The presence of standard epilogue will be tested
5968 # If last argument TESTNAME is not empty, it's used as the name of the
5969 # test to be printed on pass/fail.
5970 # Notice that the '[' and ']' characters don't need to be escaped for strings
5971 # wrapped in {} braces.
5972 proc test_class_help { command_class expected_initial_lines {list_of_commands {}} {testname {}} } {
5973 global help_list_trailer
5974 if {[llength $list_of_commands]>0} {
5975 set l_list_of_commands {"List of commands:[\r\n]+[\r\n]+"}
5976 set l_list_of_commands [concat $l_list_of_commands $list_of_commands]
5977 set l_list_of_commands [concat $l_list_of_commands {"[\r\n]+[\r\n]+"}]
5979 set l_list_of_commands {"List of commands\:.*[\r\n]+"}
5982 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5984 set l_entire_body [concat $expected_initial_lines $l_list_of_commands \
5985 $l_stock_body $help_list_trailer]
5987 help_test_raw "help ${command_class}" $l_entire_body $testname
5990 # Like test_class_help but specialised to test "help user-defined".
5991 proc test_user_defined_class_help { {list_of_commands {}} {testname {}} } {
5992 test_class_help "user-defined" {
5993 "User-defined commands\.[\r\n]+"
5994 "The commands in this class are those defined by the user\.[\r\n]+"
5995 "Use the \"define\" command to define a command\.[\r\n]+"
5996 } $list_of_commands $testname
6000 # COMMAND_LIST should have either one element -- command to test, or
6001 # two elements -- abbreviated command to test, and full command the first
6002 # element is abbreviation of.
6003 # The command must be a prefix command. EXPECTED_INITIAL_LINES
6004 # are regular expressions that should match the beginning of output,
6005 # before the list of subcommands. The presence of
6006 # subcommand list and standard epilogue will be tested automatically.
6007 proc test_prefix_command_help { command_list expected_initial_lines args } {
6008 global help_list_trailer
6009 set command [lindex $command_list 0]
6010 if {[llength $command_list]>1} {
6011 set full_command [lindex $command_list 1]
6013 set full_command $command
6015 # Use 'list' and not just {} because we want variables to
6016 # be expanded in this list.
6017 set l_stock_body [list\
6018 "List of $full_command subcommands\:.*\[\r\n\]+"\
6019 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"]
6020 set l_entire_body [concat $expected_initial_lines $l_stock_body $help_list_trailer]
6021 if {[llength $args]>0} {
6022 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
6024 help_test_raw "help ${command}" $l_entire_body
6028 # Build executable named EXECUTABLE from specifications that allow
6029 # different options to be passed to different sub-compilations.
6030 # TESTNAME is the name of the test; this is passed to 'untested' if
6032 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
6033 # contains the option "pthreads", then gdb_compile_pthreads is used.
6034 # ARGS is a flat list of source specifications, of the form:
6035 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
6036 # Each SOURCE is compiled to an object file using its OPTIONS,
6037 # using gdb_compile.
6038 # Returns 0 on success, -1 on failure.
6039 proc build_executable_from_specs {testname executable options args} {
6043 set binfile [standard_output_file $executable]
6046 if { [lsearch -exact $options "c++"] >= 0 } {
6047 set info_options "c++"
6049 if [get_compiler_info ${info_options}] {
6053 set func gdb_compile
6054 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads|openmp)$}]
6055 if {$func_index != -1} {
6056 set func "${func}_[lindex $options $func_index]"
6059 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
6060 # parameter. They also requires $sources while gdb_compile and
6061 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
6062 if [string match gdb_compile_shlib* $func] {
6064 foreach {s local_options} $args {
6065 if { [regexp "^/" "$s"] } then {
6066 lappend sources_path "$s"
6068 lappend sources_path "$srcdir/$subdir/$s"
6071 set ret [$func $sources_path "${binfile}" $options]
6072 } elseif {[lsearch -exact $options rust] != -1} {
6074 foreach {s local_options} $args {
6075 if { [regexp "^/" "$s"] } then {
6076 lappend sources_path "$s"
6078 lappend sources_path "$srcdir/$subdir/$s"
6081 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
6085 foreach {s local_options} $args {
6086 if { ! [regexp "^/" "$s"] } then {
6087 set s "$srcdir/$subdir/$s"
6089 if { [$func "${s}" "${binfile}${i}.o" object $local_options] != "" } {
6093 lappend objects "${binfile}${i}.o"
6096 set ret [$func $objects "${binfile}" executable $options]
6106 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
6107 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
6108 # to pass to untested, if something is wrong. OPTIONS are passed
6109 # to gdb_compile directly.
6110 proc build_executable { testname executable {sources ""} {options {debug}} } {
6111 if {[llength $sources]==0} {
6112 set sources ${executable}.c
6115 set arglist [list $testname $executable $options]
6116 foreach source $sources {
6117 lappend arglist $source $options
6120 return [eval build_executable_from_specs $arglist]
6123 # Starts fresh GDB binary and loads an optional executable into GDB.
6124 # Usage: clean_restart [executable]
6125 # EXECUTABLE is the basename of the binary.
6126 # Return -1 if starting gdb or loading the executable failed.
6128 proc clean_restart { args } {
6134 if { [llength $args] > 1 } {
6135 error "bad number of args: [llength $args]"
6140 # This is a clean restart, so reset error and warning count.
6145 # if { [gdb_start] == -1 } {
6148 # but gdb_start is a ${tool}_start proc, which doesn't have a defined
6149 # return value. So instead, we test for errcnt.
6151 if { $errcnt > 0 } {
6155 gdb_reinitialize_dir $srcdir/$subdir
6157 if { [llength $args] >= 1 } {
6158 set executable [lindex $args 0]
6159 set binfile [standard_output_file ${executable}]
6160 return [gdb_load ${binfile}]
6166 # Prepares for testing by calling build_executable_full, then
6168 # TESTNAME is the name of the test.
6169 # Each element in ARGS is a list of the form
6170 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
6171 # These are passed to build_executable_from_specs, which see.
6172 # The last EXECUTABLE is passed to clean_restart.
6173 # Returns 0 on success, non-zero on failure.
6174 proc prepare_for_testing_full {testname args} {
6175 foreach spec $args {
6176 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
6179 set executable [lindex $spec 0]
6181 clean_restart $executable
6185 # Prepares for testing, by calling build_executable, and then clean_restart.
6186 # Please refer to build_executable for parameter description.
6187 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
6189 if {[build_executable $testname $executable $sources $options] == -1} {
6192 clean_restart $executable
6197 # Retrieve the value of EXP in the inferior, represented in format
6198 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
6199 # print fails. TEST is the test message to use. It can be omitted,
6200 # in which case a test message is built from EXP.
6202 proc get_valueof { fmt exp default {test ""} } {
6206 set test "get valueof \"${exp}\""
6210 gdb_test_multiple "print${fmt} ${exp}" "$test" {
6211 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
6212 set val $expect_out(1,string)
6216 fail "$test (timeout)"
6222 # Retrieve the value of local var EXP in the inferior. DEFAULT is used as
6223 # fallback if print fails. TEST is the test message to use. It can be
6224 # omitted, in which case a test message is built from EXP.
6226 proc get_local_valueof { exp default {test ""} } {
6230 set test "get local valueof \"${exp}\""
6234 gdb_test_multiple "info locals ${exp}" "$test" {
6235 -re "$exp = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
6236 set val $expect_out(1,string)
6240 fail "$test (timeout)"
6246 # Retrieve the value of EXP in the inferior, as a signed decimal value
6247 # (using "print /d"). DEFAULT is used as fallback if print fails.
6248 # TEST is the test message to use. It can be omitted, in which case
6249 # a test message is built from EXP.
6251 proc get_integer_valueof { exp default {test ""} } {
6255 set test "get integer valueof \"${exp}\""
6259 gdb_test_multiple "print /d ${exp}" "$test" {
6260 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
6261 set val $expect_out(1,string)
6265 fail "$test (timeout)"
6271 # Retrieve the value of EXP in the inferior, as an hexadecimal value
6272 # (using "print /x"). DEFAULT is used as fallback if print fails.
6273 # TEST is the test message to use. It can be omitted, in which case
6274 # a test message is built from EXP.
6276 proc get_hexadecimal_valueof { exp default {test ""} } {
6280 set test "get hexadecimal valueof \"${exp}\""
6284 gdb_test_multiple "print /x ${exp}" $test {
6285 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
6286 set val $expect_out(1,string)
6293 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
6294 # is used as fallback if print fails. TEST is the test message to use.
6295 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
6297 proc get_sizeof { type default {test ""} } {
6298 return [get_integer_valueof "sizeof (${type})" $default $test]
6301 proc get_target_charset { } {
6304 gdb_test_multiple "show target-charset" "" {
6305 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
6306 return $expect_out(1,string)
6308 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
6309 return $expect_out(1,string)
6313 # Pick a reasonable default.
6314 warning "Unable to read target-charset."
6318 # Get the address of VAR.
6320 proc get_var_address { var } {
6321 global gdb_prompt hex
6323 # Match output like:
6325 # $5 = (int (*)()) 0
6326 # $6 = (int (*)()) 0x24 <function_bar>
6328 gdb_test_multiple "print &${var}" "get address of ${var}" {
6329 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
6331 pass "get address of ${var}"
6332 if { $expect_out(1,string) == "0" } {
6335 return $expect_out(1,string)
6342 # Return the frame number for the currently selected frame
6343 proc get_current_frame_number {{test_name ""}} {
6346 if { $test_name == "" } {
6347 set test_name "get current frame number"
6350 gdb_test_multiple "frame" $test_name {
6351 -re "#(\[0-9\]+) .*$gdb_prompt $" {
6352 set frame_num $expect_out(1,string)
6358 # Get the current value for remotetimeout and return it.
6359 proc get_remotetimeout { } {
6363 gdb_test_multiple "show remotetimeout" "" {
6364 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
6365 return $expect_out(1,string)
6369 # Pick the default that gdb uses
6370 warning "Unable to read remotetimeout"
6374 # Set the remotetimeout to the specified timeout. Nothing is returned.
6375 proc set_remotetimeout { timeout } {
6378 gdb_test_multiple "set remotetimeout $timeout" "" {
6379 -re "$gdb_prompt $" {
6380 verbose "Set remotetimeout to $timeout\n"
6385 # Get the target's current endianness and return it.
6386 proc get_endianness { } {
6389 gdb_test_multiple "show endian" "determine endianness" {
6390 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
6392 return $expect_out(1,string)
6398 # ROOT and FULL are file names. Returns the relative path from ROOT
6399 # to FULL. Note that FULL must be in a subdirectory of ROOT.
6400 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
6403 proc relative_filename {root full} {
6404 set root_split [file split $root]
6405 set full_split [file split $full]
6407 set len [llength $root_split]
6409 if {[eval file join $root_split]
6410 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
6411 error "$full not a subdir of $root"
6414 return [eval file join [lrange $full_split $len end]]
6417 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
6418 if {[info exists GDB_PARALLEL]} {
6419 if {[is_remote host]} {
6423 [make_gdb_parallel_path outputs] \
6424 [make_gdb_parallel_path temp] \
6425 [make_gdb_parallel_path cache]
6429 proc core_find {binfile {deletefiles {}} {arg ""}} {
6430 global objdir subdir
6432 set destcore "$binfile.core"
6433 file delete $destcore
6435 # Create a core file named "$destcore" rather than just "core", to
6436 # avoid problems with sys admin types that like to regularly prune all
6437 # files named "core" from the system.
6439 # Arbitrarily try setting the core size limit to "unlimited" since
6440 # this does not hurt on systems where the command does not work and
6441 # allows us to generate a core on systems where it does.
6443 # Some systems append "core" to the name of the program; others append
6444 # the name of the program to "core"; still others (like Linux, as of
6445 # May 2003) create cores named "core.PID". In the latter case, we
6446 # could have many core files lying around, and it may be difficult to
6447 # tell which one is ours, so let's run the program in a subdirectory.
6449 set coredir [standard_output_file coredir.[getpid]]
6451 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
6452 # remote_exec host "${binfile}"
6453 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
6454 if [remote_file build exists $i] {
6455 remote_exec build "mv $i $destcore"
6459 # Check for "core.PID".
6460 if { $found == 0 } {
6461 set names [glob -nocomplain -directory $coredir core.*]
6462 if {[llength $names] == 1} {
6463 set corefile [file join $coredir [lindex $names 0]]
6464 remote_exec build "mv $corefile $destcore"
6468 if { $found == 0 } {
6469 # The braindamaged HPUX shell quits after the ulimit -c above
6470 # without executing ${binfile}. So we try again without the
6471 # ulimit here if we didn't find a core file above.
6472 # Oh, I should mention that any "braindamaged" non-Unix system has
6473 # the same problem. I like the cd bit too, it's really neat'n stuff.
6474 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
6475 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
6476 if [remote_file build exists $i] {
6477 remote_exec build "mv $i $destcore"
6483 # Try to clean up after ourselves.
6484 foreach deletefile $deletefiles {
6485 remote_file build delete [file join $coredir $deletefile]
6487 remote_exec build "rmdir $coredir"
6489 if { $found == 0 } {
6490 warning "can't generate a core file - core tests suppressed - check ulimit -c"
6496 # gdb_target_symbol_prefix compiles a test program and then examines
6497 # the output from objdump to determine the prefix (such as underscore)
6498 # for linker symbol prefixes.
6500 gdb_caching_proc gdb_target_symbol_prefix {
6501 # Compile a simple test program...
6502 set src { int main() { return 0; } }
6503 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
6509 set objdump_program [gdb_find_objdump]
6510 set result [catch "exec $objdump_program --syms $obj" output]
6513 && ![regexp -lineanchor \
6514 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
6515 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
6523 # Return 1 if target supports scheduler locking, otherwise return 0.
6525 gdb_caching_proc target_supports_scheduler_locking {
6528 set me "gdb_target_supports_scheduler_locking"
6530 set src { int main() { return 0; } }
6531 if {![gdb_simple_compile $me $src executable]} {
6540 set supports_schedule_locking -1
6541 set current_schedule_locking_mode ""
6543 set test "reading current scheduler-locking mode"
6544 gdb_test_multiple "show scheduler-locking" $test {
6545 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
6546 set current_schedule_locking_mode $expect_out(1,string)
6548 -re "$gdb_prompt $" {
6549 set supports_schedule_locking 0
6552 set supports_schedule_locking 0
6556 if { $supports_schedule_locking == -1 } {
6557 set test "checking for scheduler-locking support"
6558 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
6559 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
6560 set supports_schedule_locking 0
6562 -re "$gdb_prompt $" {
6563 set supports_schedule_locking 1
6566 set supports_schedule_locking 0
6571 if { $supports_schedule_locking == -1 } {
6572 set supports_schedule_locking 0
6576 remote_file build delete $obj
6577 verbose "$me: returning $supports_schedule_locking" 2
6578 return $supports_schedule_locking
6581 # Return 1 if compiler supports use of nested functions. Otherwise,
6584 gdb_caching_proc support_nested_function_tests {
6585 # Compile a test program containing a nested function
6586 return [gdb_can_simple_compile nested_func {
6596 # gdb_target_symbol returns the provided symbol with the correct prefix
6597 # prepended. (See gdb_target_symbol_prefix, above.)
6599 proc gdb_target_symbol { symbol } {
6600 set prefix [gdb_target_symbol_prefix]
6601 return "${prefix}${symbol}"
6604 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6605 # added to gdb_compile options to define the C-preprocessor macro
6606 # SYMBOL_PREFIX with a value that can be prepended to symbols
6607 # for targets which require a prefix, such as underscore.
6609 # This version (_asm) defines the prefix without double quotes
6610 # surrounding the prefix. It is used to define the macro
6611 # SYMBOL_PREFIX for assembly language files. Another version, below,
6612 # is used for symbols in inline assembler in C/C++ files.
6614 # The lack of quotes in this version (_asm) makes it possible to
6615 # define supporting macros in the .S file. (The version which
6616 # uses quotes for the prefix won't work for such files since it's
6617 # impossible to define a quote-stripping macro in C.)
6619 # It's possible to use this version (_asm) for C/C++ source files too,
6620 # but a string is usually required in such files; providing a version
6621 # (no _asm) which encloses the prefix with double quotes makes it
6622 # somewhat easier to define the supporting macros in the test case.
6624 proc gdb_target_symbol_prefix_flags_asm {} {
6625 set prefix [gdb_target_symbol_prefix]
6626 if {$prefix ne ""} {
6627 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6633 # gdb_target_symbol_prefix_flags returns the same string as
6634 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6635 # enclosed in double quotes if there is a prefix.
6637 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6638 # extended discussion.
6640 proc gdb_target_symbol_prefix_flags {} {
6641 set prefix [gdb_target_symbol_prefix]
6642 if {$prefix ne ""} {
6643 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
6649 # A wrapper for 'remote_exec host' that passes or fails a test.
6650 # Returns 0 if all went well, nonzero on failure.
6651 # TEST is the name of the test, other arguments are as for remote_exec.
6653 proc run_on_host { test program args } {
6654 verbose -log "run_on_host: $program $args"
6655 # remote_exec doesn't work properly if the output is set but the
6656 # input is the empty string -- so replace an empty input with
6658 if {[llength $args] > 1 && [lindex $args 1] == ""} {
6659 set args [lreplace $args 1 1 "/dev/null"]
6661 set result [eval remote_exec host [list $program] $args]
6662 verbose "result is $result"
6663 set status [lindex $result 0]
6664 set output [lindex $result 1]
6669 verbose -log "run_on_host failed: $output"
6675 # Return non-zero if "board_info debug_flags" mentions Fission.
6676 # http://gcc.gnu.org/wiki/DebugFission
6677 # Fission doesn't support everything yet.
6678 # This supports working around bug 15954.
6680 proc using_fission { } {
6681 set debug_flags [board_info [target_info name] debug_flags]
6682 return [regexp -- "-gsplit-dwarf" $debug_flags]
6685 # Search the caller's ARGS list and set variables according to the list of
6686 # valid options described by ARGSET.
6688 # The first member of each one- or two-element list in ARGSET defines the
6689 # name of a variable that will be added to the caller's scope.
6691 # If only one element is given to describe an option, it the value is
6692 # 0 if the option is not present in (the caller's) ARGS or 1 if
6695 # If two elements are given, the second element is the default value of
6696 # the variable. This is then overwritten if the option exists in ARGS.
6698 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
6699 # any optional components.
6702 # proc myproc {foo args} {
6703 # parse_args {{bar} {baz "abc"} {qux}}
6706 # myproc ABC -bar -baz DEF peanut butter
6707 # will define the following variables in myproc:
6708 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6709 # args will be the list {peanut butter}
6711 proc parse_args { argset } {
6714 foreach argument $argset {
6715 if {[llength $argument] == 1} {
6716 # No default specified, so we assume that we should set
6717 # the value to 1 if the arg is present and 0 if it's not.
6718 # It is assumed that no value is given with the argument.
6719 set result [lsearch -exact $args "-$argument"]
6720 if {$result != -1} then {
6721 uplevel 1 [list set $argument 1]
6722 set args [lreplace $args $result $result]
6724 uplevel 1 [list set $argument 0]
6726 } elseif {[llength $argument] == 2} {
6727 # There are two items in the argument. The second is a
6728 # default value to use if the item is not present.
6729 # Otherwise, the variable is set to whatever is provided
6730 # after the item in the args.
6731 set arg [lindex $argument 0]
6732 set result [lsearch -exact $args "-[lindex $arg 0]"]
6733 if {$result != -1} then {
6734 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
6735 set args [lreplace $args $result [expr $result+1]]
6737 uplevel 1 [list set $arg [lindex $argument 1]]
6740 error "Badly formatted argument \"$argument\" in argument set"
6744 # The remaining args should be checked to see that they match the
6745 # number of items expected to be passed into the procedure...
6748 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
6749 # return that string.
6751 proc capture_command_output { command prefix } {
6755 set output_string ""
6756 gdb_test_multiple "$command" "capture_command_output for $command" {
6757 -re "[string_to_regexp ${command}]\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
6758 set output_string $expect_out(1,string)
6761 return $output_string
6764 # A convenience function that joins all the arguments together, with a
6765 # regexp that matches exactly one end of line in between each argument.
6766 # This function is ideal to write the expected output of a GDB command
6767 # that generates more than a couple of lines, as this allows us to write
6768 # each line as a separate string, which is easier to read by a human
6771 proc multi_line { args } {
6772 return [join $args "\r\n"]
6775 # Similar to the above, but while multi_line is meant to be used to
6776 # match GDB output, this one is meant to be used to build strings to
6777 # send as GDB input.
6779 proc multi_line_input { args } {
6780 return [join $args "\n"]
6783 # Return the version of the DejaGnu framework.
6785 # The return value is a list containing the major, minor and patch version
6786 # numbers. If the version does not contain a minor or patch number, they will
6787 # be set to 0. For example:
6793 proc dejagnu_version { } {
6794 # The frame_version variable is defined by DejaGnu, in runtest.exp.
6795 global frame_version
6797 verbose -log "DejaGnu version: $frame_version"
6798 verbose -log "Expect version: [exp_version]"
6799 verbose -log "Tcl version: [info tclversion]"
6801 set dg_ver [split $frame_version .]
6803 while { [llength $dg_ver] < 3 } {
6810 # Define user-defined command COMMAND using the COMMAND_LIST as the
6811 # command's definition. The terminating "end" is added automatically.
6813 proc gdb_define_cmd {command command_list} {
6816 set input [multi_line_input {*}$command_list "end"]
6817 set test "define $command"
6819 gdb_test_multiple "define $command" $test {
6821 gdb_test_multiple $input $test {
6822 -re "\r\n$gdb_prompt " {
6829 # Override the 'cd' builtin with a version that ensures that the
6830 # log file keeps pointing at the same file. We need this because
6831 # unfortunately the path to the log file is recorded using an
6832 # relative path name, and, we sometimes need to close/reopen the log
6833 # after changing the current directory. See get_compiler_info.
6835 rename cd builtin_cd
6839 # Get the existing log file flags.
6840 set log_file_info [log_file -info]
6842 # Split the flags into args and file name.
6843 set log_file_flags ""
6844 set log_file_file ""
6845 foreach arg [ split "$log_file_info" " "] {
6846 if [string match "-*" $arg] {
6847 lappend log_file_flags $arg
6849 lappend log_file_file $arg
6853 # If there was an existing file, ensure it is an absolute path, and then
6855 if { $log_file_file != "" } {
6856 set log_file_file [file normalize $log_file_file]
6858 log_file $log_file_flags "$log_file_file"
6861 # Call the builtin version of cd.
6865 # Return a list of all languages supported by GDB, suitable for use in
6866 # 'set language NAME'. This doesn't include either the 'local' or
6868 proc gdb_supported_languages {} {
6869 return [list c objective-c c++ d go fortran modula-2 asm pascal \
6870 opencl rust minimal ada]
6873 # Check if debugging is enabled for gdb.
6875 proc gdb_debug_enabled { } {
6878 # If not already read, get the debug setting from environment or board setting.
6879 if {![info exists gdbdebug]} {
6881 if [info exists env(GDB_DEBUG)] {
6882 set gdbdebug $env(GDB_DEBUG)
6883 } elseif [target_info exists gdb,debug] {
6884 set gdbdebug [target_info gdb,debug]
6890 # Ensure it not empty.
6891 return [expr { $gdbdebug != "" }]
6894 # Turn on debugging if enabled, or reset if already on.
6896 proc gdb_debug_init { } {
6900 if ![gdb_debug_enabled] {
6904 # First ensure logging is off.
6905 send_gdb "set logging off\n"
6907 set debugfile [standard_output_file gdb.debug]
6908 send_gdb "set logging file $debugfile\n"
6910 send_gdb "set logging debugredirect\n"
6913 foreach entry [split $gdbdebug ,] {
6914 send_gdb "set debug $entry 1\n"
6917 # Now that everything is set, enable logging.
6918 send_gdb "set logging on\n"
6920 -re "Copying output to $debugfile.*Redirecting debug output to $debugfile.*$gdb_prompt $" {}
6921 timeout { warning "Couldn't set logging file" }
6925 # Check if debugging is enabled for gdbserver.
6927 proc gdbserver_debug_enabled { } {
6928 # Always disabled for GDB only setups.
6932 # Open the file for logging gdb input
6934 proc gdb_stdin_log_init { } {
6937 if {[info exists in_file]} {
6938 # Close existing file.
6939 catch "close $in_file"
6942 set logfile [standard_output_file_with_gdb_instance gdb.in]
6943 set in_file [open $logfile w]
6946 # Write to the file for logging gdb input.
6947 # TYPE can be one of the following:
6948 # "standard" : Default. Standard message written to the log
6949 # "answer" : Answer to a question (eg "Y"). Not written the log.
6950 # "optional" : Optional message. Not written to the log.
6952 proc gdb_stdin_log_write { message {type standard} } {
6955 if {![info exists in_file]} {
6959 # Check message types.
6960 switch -regexp -- $type {
6970 puts -nonewline $in_file "$message"
6973 # Write the command line used to invocate gdb to the cmd file.
6975 proc gdb_write_cmd_file { cmdline } {
6976 set logfile [standard_output_file_with_gdb_instance gdb.cmd]
6977 set cmd_file [open $logfile w]
6978 puts $cmd_file $cmdline
6979 catch "close $cmd_file"
6982 # Compare contents of FILE to string STR. Pass with MSG if equal, otherwise
6985 proc cmp_file_string { file str msg } {
6986 if { ![file exists $file]} {
6991 set caught_error [catch {
6992 set fp [open "$file" r]
6993 set file_contents [read $fp]
6996 if { $caught_error } then {
6997 error "$error_message"
7002 if { $file_contents == $str } {
7009 # Does the compiler support CTF debug output using '-gt' compiler
7010 # flag? If not then we should skip these tests.
7012 gdb_caching_proc skip_ctf_tests {
7013 return ![gdb_can_simple_compile ctfdebug {
7017 } executable "additional_flags=-gt"]
7020 # Return 1 if compiler supports -gstatement-frontiers. Otherwise,
7023 gdb_caching_proc supports_statement_frontiers {
7024 return [gdb_can_simple_compile supports_statement_frontiers {
7028 } executable "additional_flags=-gstatement-frontiers"]
7031 # Return 1 if compiler supports -mmpx -fcheck-pointer-bounds. Otherwise,
7034 gdb_caching_proc supports_mpx_check_pointer_bounds {
7035 set flags "additional_flags=-mmpx additional_flags=-fcheck-pointer-bounds"
7036 return [gdb_can_simple_compile supports_mpx_check_pointer_bounds {
7040 } executable $flags]
7043 # Return 1 if compiler supports -fcf-protection=. Otherwise,
7046 gdb_caching_proc supports_fcf_protection {
7047 return [gdb_can_simple_compile supports_fcf_protection {
7051 } executable "additional_flags=-fcf-protection=full"]
7054 # Return 1 if symbols were read in using -readnow. Otherwise, return 0.
7057 set cmd "maint print objfiles"
7058 gdb_test_multiple $cmd "" {
7059 -re -wrap "\r\n.gdb_index: faked for \"readnow\"\r\n.*" {
7070 # Return 1 if partial symbols are available. Otherwise, return 0.
7072 proc psymtabs_p { } {
7075 set cmd "maint info psymtab"
7076 gdb_test_multiple $cmd "" {
7077 -re "$cmd\r\n$gdb_prompt $" {
7088 # Verify that partial symtab expansion for $filename has state $readin.
7090 proc verify_psymtab_expanded { filename readin } {
7093 set cmd "maint info psymtab"
7094 set test "$cmd: $filename: $readin"
7095 set re [multi_line \
7096 " \{ psymtab \[^\r\n\]*$filename\[^\r\n\]*" \
7100 gdb_test_multiple $cmd $test {
7101 -re "$cmd\r\n$gdb_prompt $" {
7102 unsupported $gdb_test_name
7110 # Add a .gdb_index section to PROGRAM.
7111 # PROGRAM is assumed to be the output of standard_output_file.
7112 # Returns the 0 if there is a failure, otherwise 1.
7114 proc add_gdb_index { program } {
7115 global srcdir GDB env BUILD_DATA_DIRECTORY
7116 set contrib_dir "$srcdir/../contrib"
7117 set env(GDB) "$GDB --data-directory=$BUILD_DATA_DIRECTORY"
7118 set result [catch "exec $contrib_dir/gdb-add-index.sh $program" output]
7119 if { $result != 0 } {
7120 verbose -log "result is $result"
7121 verbose -log "output is $output"
7128 # Add a .gdb_index section to PROGRAM, unless it alread has an index
7129 # (.gdb_index/.debug_names). Gdb doesn't support building an index from a
7130 # program already using one. Return 1 if a .gdb_index was added, return 0
7131 # if it already contained an index, and -1 if an error occurred.
7133 proc ensure_gdb_index { binfile } {
7134 set testfile [file tail $binfile]
7135 set test "check if index present"
7136 gdb_test_multiple "mt print objfiles ${testfile}" $test {
7137 -re -wrap "gdb_index.*" {
7140 -re -wrap "debug_names.*" {
7143 -re -wrap "Psymtabs.*" {
7144 if { [add_gdb_index $binfile] != "1" } {
7153 # Return 1 if executable contains .debug_types section. Otherwise, return 0.
7155 proc debug_types { } {
7158 set cmd "maint info sections"
7159 gdb_test_multiple $cmd "" {
7160 -re -wrap "at $hex: .debug_types.*" {
7171 # Return the addresses in the line table for FILE for which is_stmt is true.
7173 proc is_stmt_addresses { file } {
7179 gdb_test_multiple "maint info line-table $file" "" {
7180 -re "\r\n$decimal\[ \t\]+$decimal\[ \t\]+($hex)\[ \t\]+Y\[^\r\n\]*" {
7181 lappend is_stmt $expect_out(1,string)
7191 # Return 1 if hex number VAL is an element of HEXLIST.
7193 proc hex_in_list { val hexlist } {
7194 # Normalize val by removing 0x prefix, and leading zeros.
7195 set val [regsub ^0x $val ""]
7196 set val [regsub ^0+ $val "0"]
7199 set index [lsearch -regexp $hexlist $re]
7200 return [expr $index != -1]
7203 # Override proc NAME to proc OVERRIDE for the duration of the execution of
7206 proc with_override { name override body } {
7207 # Implementation note: It's possible to implement the override using
7208 # rename, like this:
7209 # rename $name save_$name
7210 # rename $override $name
7211 # set code [catch {uplevel 1 $body} result]
7212 # rename $name $override
7213 # rename save_$name $name
7214 # but there are two issues here:
7215 # - the save_$name might clash with an existing proc
7216 # - the override is no longer available under its original name during
7218 # So, we use this more elaborate but cleaner mechanism.
7220 # Save the old proc.
7221 set old_args [info args $name]
7222 set old_body [info body $name]
7224 # Install the override.
7225 set new_args [info args $override]
7226 set new_body [info body $override]
7227 eval proc $name {$new_args} {$new_body}
7230 set code [catch {uplevel 1 $body} result]
7233 eval proc $name {$old_args} {$old_body}
7235 # Return as appropriate.
7237 global errorInfo errorCode
7238 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
7239 } elseif { $code > 1 } {
7240 return -code $code $result
7246 # Always load compatibility stuff.