1 # Copyright 1992-2023 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"
28 # Execute BODY, if COND wrapped in proc WRAP.
29 # Instead of writing the verbose and repetitive:
36 # cond_wrap $cond wrap $body
38 proc cond_wrap { cond wrap body } {
48 # Add VAR_ID=VAL to ENV_VAR, unless ENV_VAR already contains a VAR_ID setting.
50 proc set_sanitizer_default { env_var var_id val } {
53 if { ![info exists env($env_var) ]
54 || $env($env_var) == "" } {
55 # Set var_id (env_var non-existing / empty case).
56 append env($env_var) $var_id=$val
60 if { [regexp $var_id= $env($env_var)] } {
61 # Don't set var_id. It's already set by the user, leave as is.
62 # Note that we could probably get the same result by unconditionally
63 # prepending it, but this way is less likely to cause confusion.
67 # Set var_id (env_var not empty case).
68 append env($env_var) : $var_id=$val
71 set_sanitizer_default TSAN_OPTIONS suppressions \
72 $srcdir/../tsan-suppressions.txt
74 # If GDB is built with ASAN (and because there are leaks), it will output a
75 # leak report when exiting as well as exit with a non-zero (failure) status.
76 # This can affect tests that are sensitive to what GDB prints on stderr or its
77 # exit status. Add `detect_leaks=0` to the ASAN_OPTIONS environment variable
78 # (which will affect any spawned sub-process) to avoid this.
79 set_sanitizer_default ASAN_OPTIONS detect_leaks 0
81 # List of procs to run in gdb_finish.
82 set gdb_finish_hooks [list]
84 # Variable in which we keep track of globals that are allowed to be live
86 array set gdb_persistent_globals {}
88 # Mark variable names in ARG as a persistent global, and declare them as
89 # global in the calling context. Can be used to rewrite "global var_a var_b"
90 # into "gdb_persistent_global var_a var_b".
91 proc gdb_persistent_global { args } {
92 global gdb_persistent_globals
93 foreach varname $args {
94 uplevel 1 global $varname
95 set gdb_persistent_globals($varname) 1
99 # Mark variable names in ARG as a persistent global.
100 proc gdb_persistent_global_no_decl { args } {
101 global gdb_persistent_globals
102 foreach varname $args {
103 set gdb_persistent_globals($varname) 1
107 # Override proc load_lib.
108 rename load_lib saved_load_lib
109 # Run the runtest version of load_lib, and mark all variables that were
110 # created by this call as persistent.
111 proc load_lib { file } {
112 array set known_global {}
113 foreach varname [info globals] {
114 set known_globals($varname) 1
117 set code [catch "saved_load_lib $file" result]
119 foreach varname [info globals] {
120 if { ![info exists known_globals($varname)] } {
121 gdb_persistent_global_no_decl $varname
126 global errorInfo errorCode
127 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
128 } elseif {$code > 1} {
129 return -code $code $result
135 load_lib libgloss.exp
137 load_lib gdb-utils.exp
139 load_lib check-test-names.exp
141 # The path to the GDB binary to test.
144 # The data directory to use for testing. If this is the empty string,
145 # then we let GDB use its own configured data directory.
146 global GDB_DATA_DIRECTORY
148 # The spawn ID used for I/O interaction with the inferior. For native
149 # targets, or remote targets that can do I/O through GDB
150 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
151 # Otherwise, the board may set this to some other spawn ID. E.g.,
152 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
153 # so input/output is done on gdbserver's tty.
154 global inferior_spawn_id
156 if [info exists TOOL_EXECUTABLE] {
157 set GDB $TOOL_EXECUTABLE
159 if ![info exists GDB] {
160 if ![is_remote host] {
161 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
163 set GDB [transform gdb]
166 # If the user specifies GDB on the command line, and doesn't
167 # specify GDB_DATA_DIRECTORY, then assume we're testing an
168 # installed GDB, and let it use its own configured data directory.
169 if ![info exists GDB_DATA_DIRECTORY] {
170 set GDB_DATA_DIRECTORY ""
173 verbose "using GDB = $GDB" 2
175 # The data directory the testing GDB will use. By default, assume
176 # we're testing a non-installed GDB in the build directory. Users may
177 # also explictly override the -data-directory from the command line.
178 if ![info exists GDB_DATA_DIRECTORY] {
179 set GDB_DATA_DIRECTORY [file normalize "[pwd]/../data-directory"]
181 verbose "using GDB_DATA_DIRECTORY = $GDB_DATA_DIRECTORY" 2
183 # GDBFLAGS is available for the user to set on the command line.
184 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
185 # Testcases may use it to add additional flags, but they must:
186 # - append new flags, not overwrite
187 # - restore the original value when done
189 if ![info exists GDBFLAGS] {
192 verbose "using GDBFLAGS = $GDBFLAGS" 2
194 # Append the -data-directory option to pass to GDB to CMDLINE and
195 # return the resulting string. If GDB_DATA_DIRECTORY is empty,
196 # nothing is appended.
197 proc append_gdb_data_directory_option {cmdline} {
198 global GDB_DATA_DIRECTORY
200 if { $GDB_DATA_DIRECTORY != "" } {
201 return "$cmdline -data-directory $GDB_DATA_DIRECTORY"
207 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
208 # `-nw' disables any of the windowed interfaces.
209 # `-nx' disables ~/.gdbinit, so that it doesn't interfere with the tests.
210 # `-iex "set {height,width} 0"' disables pagination.
211 # `-data-directory' points to the data directory, usually in the build
213 global INTERNAL_GDBFLAGS
214 if ![info exists INTERNAL_GDBFLAGS] {
215 set INTERNAL_GDBFLAGS \
220 {-iex "set height 0"} \
221 {-iex "set width 0"}]]
223 # If DEBUGINFOD_URLS is set, gdb will try to download sources and
224 # debug info for f.i. system libraries. Prevent this.
225 if { [is_remote host] } {
226 # Setting environment variables on build has no effect on remote host,
227 # so handle this using "set debuginfod enabled off" instead.
228 set INTERNAL_GDBFLAGS \
229 "$INTERNAL_GDBFLAGS -iex \"set debuginfod enabled off\""
231 # See default_gdb_init.
234 set INTERNAL_GDBFLAGS [append_gdb_data_directory_option $INTERNAL_GDBFLAGS]
237 # The variable gdb_prompt is a regexp which matches the gdb prompt.
238 # Set it if it is not already set. This is also set by default_gdb_init
239 # but it's not clear what removing one of them will break.
240 # See with_gdb_prompt for more details on prompt handling.
242 if {![info exists gdb_prompt]} {
243 set gdb_prompt "\\(gdb\\)"
246 # A regexp that matches the pagination prompt.
247 set pagination_prompt \
248 "--Type <RET> for more, q to quit, c to continue without paging--"
250 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
251 # absolute path ie. /foo/
252 set fullname_syntax_POSIX {/[^\n]*/}
253 # The variable fullname_syntax_UNC is a regexp which matches a Windows
254 # UNC path ie. \\D\foo\
255 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
256 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
257 # particular DOS case that GDB most likely will output
258 # ie. \foo\, but don't match \\.*\
259 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
260 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
261 # ie. a:\foo\ && a:foo\
262 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
263 # The variable fullname_syntax is a regexp which matches what GDB considers
264 # an absolute path. It is currently debatable if the Windows style paths
265 # d:foo and \abc should be considered valid as an absolute path.
266 # Also, the purpse of this regexp is not to recognize a well formed
267 # absolute path, but to say with certainty that a path is absolute.
268 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
270 # Needed for some tests under Cygwin.
274 if ![info exists env(EXEEXT)] {
277 set EXEEXT $env(EXEEXT)
282 set inferior_exited_re "(?:\\\[Inferior \[0-9\]+ \\(\[^\n\r\]*\\) exited)"
284 # A regular expression that matches a value history number.
286 set valnum_re "\\\$$decimal"
288 # A regular expression that matches a breakpoint hit with a breakpoint
289 # having several code locations.
290 set bkptno_num_re "$decimal\\.$decimal"
292 # A regular expression that matches a breakpoint hit
293 # with one or several code locations.
294 set bkptno_numopt_re "($decimal\\.$decimal|$decimal)"
296 ### Only procedures should come after this point.
299 # gdb_version -- extract and print the version number of GDB
301 proc default_gdb_version {} {
303 global INTERNAL_GDBFLAGS GDBFLAGS
307 if {[info exists inotify_pid]} {
308 eval exec kill $inotify_pid
311 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
312 set tmp [lindex $output 1]
314 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
315 if ![is_remote host] {
316 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
318 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
322 proc gdb_version { } {
323 return [default_gdb_version]
326 # gdb_unload -- unload a file if one is loaded
328 # Returns the same as gdb_test_multiple.
330 proc gdb_unload { {msg "file"} } {
333 return [gdb_test_multiple "file" $msg {
334 -re "A program is being debugged already.\r\nAre you sure you want to change the file. .y or n. $" {
335 send_gdb "y\n" answer
339 -re "No executable file now\\.\r\n" {
343 -re "Discard symbol table from `.*'. .y or n. $" {
344 send_gdb "y\n" answer
348 -re -wrap "No symbol file now\\." {
354 # Many of the tests depend on setting breakpoints at various places and
355 # running until that breakpoint is reached. At times, we want to start
356 # with a clean-slate with respect to breakpoints, so this utility proc
357 # lets us do this without duplicating this code everywhere.
360 proc delete_breakpoints {} {
363 # we need a larger timeout value here or this thing just confuses
364 # itself. May need a better implementation if possible. - guo
368 set msg "delete all breakpoints in delete_breakpoints"
370 gdb_test_multiple "delete breakpoints" "$msg" {
371 -re "Delete all breakpoints.*y or n.*$" {
372 send_gdb "y\n" answer
375 -re "$gdb_prompt $" {
381 # Confirm with "info breakpoints".
383 set msg "info breakpoints"
384 gdb_test_multiple $msg $msg {
385 -re "No breakpoints or watchpoints..*$gdb_prompt $" {
388 -re "$gdb_prompt $" {
394 perror "breakpoints not deleted"
398 # Returns true iff the target supports using the "run" command.
400 proc target_can_use_run_cmd { {target_description ""} } {
401 if { $target_description == "" } {
403 } elseif { $target_description == "core" } {
404 # We could try to figure this out by issuing an "info target" and
405 # checking for "Local core dump file:", but it would mean the proc
406 # would start requiring a current target. Also, uses while gdb
407 # produces non-standard output due to, say annotations would
408 # have to be moved around or eliminated, which would further limit
412 error "invalid argument: $target_description"
415 if [target_info exists use_gdb_stub] {
416 # In this case, when we connect, the inferior is already
421 if { $have_core && [target_info gdb_protocol] == "extended-remote" } {
422 # In this case, when we connect, the inferior is not running but
423 # cannot be made to run.
431 # Generic run command.
433 # Return 0 if we could start the program, -1 if we could not.
435 # The second pattern below matches up to the first newline *only*.
436 # Using ``.*$'' could swallow up output that we attempt to match
439 # INFERIOR_ARGS is passed as arguments to the start command, so may contain
440 # inferior arguments.
442 # N.B. This function does not wait for gdb to return to the prompt,
443 # that is the caller's responsibility.
445 proc gdb_run_cmd { {inferior_args {}} } {
446 global gdb_prompt use_gdb_stub
448 foreach command [gdb_init_commands] {
449 send_gdb "$command\n"
451 -re "$gdb_prompt $" { }
453 perror "gdb_init_command for target failed"
460 if [target_info exists gdb,do_reload_on_run] {
461 if { [gdb_reload $inferior_args] != 0 } {
464 send_gdb "continue\n"
466 -re "Continu\[^\r\n\]*\[\r\n\]" {}
472 if [target_info exists gdb,start_symbol] {
473 set start [target_info gdb,start_symbol]
477 send_gdb "jump *$start\n"
479 while { $start_attempt } {
480 # Cap (re)start attempts at three to ensure that this loop
481 # always eventually fails. Don't worry about trying to be
482 # clever and not send a command when it has failed.
483 if [expr $start_attempt > 3] {
484 perror "Jump to start() failed (retry count exceeded)"
487 set start_attempt [expr $start_attempt + 1]
489 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
492 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
493 perror "Can't find start symbol to run in gdb_run"
496 -re "No symbol \"start\" in current.*$gdb_prompt $" {
497 send_gdb "jump *_start\n"
499 -re "No symbol.*context.*$gdb_prompt $" {
502 -re "Line.* Jump anyway.*y or n. $" {
503 send_gdb "y\n" answer
505 -re "The program is not being run.*$gdb_prompt $" {
506 if { [gdb_reload $inferior_args] != 0 } {
509 send_gdb "jump *$start\n"
512 perror "Jump to start() failed (timeout)"
521 if [target_info exists gdb,do_reload_on_run] {
522 if { [gdb_reload $inferior_args] != 0 } {
526 send_gdb "run $inferior_args\n"
527 # This doesn't work quite right yet.
528 # Use -notransfer here so that test cases (like chng-sym.exp)
529 # may test for additional start-up messages.
531 -re "The program .* has been started already.*y or n. $" {
532 send_gdb "y\n" answer
535 -notransfer -re "Starting program: \[^\r\n\]*" {}
536 -notransfer -re "$gdb_prompt $" {
537 # There is no more input expected.
539 -notransfer -re "A problem internal to GDB has been detected" {
540 # Let caller handle this.
547 # Generic start command. Return 0 if we could start the program, -1
550 # INFERIOR_ARGS is passed as arguments to the start command, so may contain
551 # inferior arguments.
553 # N.B. This function does not wait for gdb to return to the prompt,
554 # that is the caller's responsibility.
556 proc gdb_start_cmd { {inferior_args {}} } {
557 global gdb_prompt use_gdb_stub
559 foreach command [gdb_init_commands] {
560 send_gdb "$command\n"
562 -re "$gdb_prompt $" { }
564 perror "gdb_init_command for target failed"
574 send_gdb "start $inferior_args\n"
575 # Use -notransfer here so that test cases (like chng-sym.exp)
576 # may test for additional start-up messages.
578 -re "The program .* has been started already.*y or n. $" {
579 send_gdb "y\n" answer
582 -notransfer -re "Starting program: \[^\r\n\]*" {
585 -re "$gdb_prompt $" { }
590 # Generic starti command. Return 0 if we could start the program, -1
593 # INFERIOR_ARGS is passed as arguments to the starti command, so may contain
594 # inferior arguments.
596 # N.B. This function does not wait for gdb to return to the prompt,
597 # that is the caller's responsibility.
599 proc gdb_starti_cmd { {inferior_args {}} } {
600 global gdb_prompt use_gdb_stub
602 foreach command [gdb_init_commands] {
603 send_gdb "$command\n"
605 -re "$gdb_prompt $" { }
607 perror "gdb_init_command for target failed"
617 send_gdb "starti $inferior_args\n"
619 -re "The program .* has been started already.*y or n. $" {
620 send_gdb "y\n" answer
623 -re "Starting program: \[^\r\n\]*" {
630 # Set a breakpoint using LINESPEC.
632 # If there is an additional argument it is a list of options; the supported
633 # options are allow-pending, temporary, message, no-message and qualified.
635 # The result is 1 for success, 0 for failure.
637 # Note: The handling of message vs no-message is messed up, but it's based
638 # on historical usage. By default this function does not print passes,
640 # no-message: turns off printing of fails (and passes, but they're already off)
641 # message: turns on printing of passes (and fails, but they're already on)
643 proc gdb_breakpoint { linespec args } {
647 set pending_response n
648 if {[lsearch -exact $args allow-pending] != -1} {
649 set pending_response y
652 set break_command "break"
653 set break_message "Breakpoint"
654 if {[lsearch -exact $args temporary] != -1} {
655 set break_command "tbreak"
656 set break_message "Temporary breakpoint"
659 if {[lsearch -exact $args qualified] != -1} {
660 append break_command " -qualified"
665 set no_message_loc [lsearch -exact $args no-message]
666 set message_loc [lsearch -exact $args message]
667 # The last one to appear in args wins.
668 if { $no_message_loc > $message_loc } {
670 } elseif { $message_loc > $no_message_loc } {
674 set test_name "gdb_breakpoint: set breakpoint at $linespec"
675 # The first two regexps are what we get with -g, the third is without -g.
676 gdb_test_multiple "$break_command $linespec" $test_name {
677 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
678 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
679 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
680 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
681 if {$pending_response == "n"} {
688 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
689 send_gdb "$pending_response\n"
692 -re "$gdb_prompt $" {
705 # Set breakpoint at function and run gdb until it breaks there.
706 # Since this is the only breakpoint that will be set, if it stops
707 # at a breakpoint, we will assume it is the one we want. We can't
708 # just compare to "function" because it might be a fully qualified,
709 # single quoted C++ function specifier.
711 # If there are additional arguments, pass them to gdb_breakpoint.
712 # We recognize no-message/message ourselves.
714 # no-message is messed up here, like gdb_breakpoint: to preserve
715 # historical usage fails are always printed by default.
716 # no-message: turns off printing of fails (and passes, but they're already off)
717 # message: turns on printing of passes (and fails, but they're already on)
719 proc runto { linespec args } {
721 global bkptno_numopt_re
728 set no_message_loc [lsearch -exact $args no-message]
729 set message_loc [lsearch -exact $args message]
730 # The last one to appear in args wins.
731 if { $no_message_loc > $message_loc } {
733 } elseif { $message_loc > $no_message_loc } {
737 set test_name "runto: run to $linespec"
739 if {![gdb_breakpoint $linespec {*}$args]} {
745 # the "at foo.c:36" output we get with -g.
746 # the "in func" output we get without -g.
748 -re "(?:Break|Temporary break).* at .*:$decimal.*$gdb_prompt $" {
754 -re "(?:Breakpoint|Temporary breakpoint) $bkptno_numopt_re, \[0-9xa-f\]* in .*$gdb_prompt $" {
760 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
762 unsupported "non-stop mode not supported"
766 -re ".*A problem internal to GDB has been detected" {
767 # Always emit a FAIL if we encounter an internal error: internal
768 # errors are never expected.
769 fail "$test_name (GDB internal error)"
770 gdb_internal_error_resync
773 -re "$gdb_prompt $" {
781 fail "$test_name (eof)"
787 fail "$test_name (timeout)"
798 # Ask gdb to run until we hit a breakpoint at main.
800 # N.B. This function deletes all existing breakpoints.
801 # If you don't want that, use gdb_start_cmd.
803 proc runto_main { } {
804 return [runto main qualified]
807 ### Continue, and expect to hit a breakpoint.
808 ### Report a pass or fail, depending on whether it seems to have
809 ### worked. Use NAME as part of the test name; each call to
810 ### continue_to_breakpoint should use a NAME which is unique within
812 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
814 set full_name "continue to breakpoint: $name"
816 set kfail_pattern "Process record does not support instruction 0xfae64 at.*"
817 gdb_test_multiple "continue" $full_name {
818 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
821 -re "\[\r\n\]*(?:$kfail_pattern)\[\r\n\]+$gdb_prompt $" {
822 kfail "gdb/25038" $full_name
828 # gdb_internal_error_resync:
830 # Answer the questions GDB asks after it reports an internal error
831 # until we get back to a GDB prompt. Decline to quit the debugging
832 # session, and decline to create a core file. Return non-zero if the
835 # This procedure just answers whatever questions come up until it sees
836 # a GDB prompt; it doesn't require you to have matched the input up to
837 # any specific point. However, it only answers questions it sees in
838 # the output itself, so if you've matched a question, you had better
839 # answer it yourself before calling this.
841 # You can use this function thus:
845 # -re ".*A problem internal to GDB has been detected" {
846 # gdb_internal_error_resync
851 proc gdb_internal_error_resync {} {
854 verbose -log "Resyncing due to internal error."
857 while {$count < 10} {
859 -re "Recursive internal problem\\." {
860 perror "Could not resync from internal error (recursive internal problem)"
863 -re "Quit this debugging session\\? \\(y or n\\) $" {
864 send_gdb "n\n" answer
867 -re "Create a core file of GDB\\? \\(y or n\\) $" {
868 send_gdb "n\n" answer
871 -re "$gdb_prompt $" {
872 # We're resynchronized.
876 perror "Could not resync from internal error (timeout)"
880 perror "Could not resync from internal error (eof)"
885 perror "Could not resync from internal error (resync count exceeded)"
889 # Fill in the default prompt if PROMPT_REGEXP is empty.
891 # If WITH_ANCHOR is true and the default prompt is used, append a `$` at the end
892 # of the regexp, to anchor the match at the end of the buffer.
893 proc fill_in_default_prompt {prompt_regexp with_anchor} {
894 if { "$prompt_regexp" == "" } {
895 set prompt "$::gdb_prompt "
897 if { $with_anchor } {
903 return $prompt_regexp
906 # gdb_test_multiple COMMAND MESSAGE [ -prompt PROMPT_REGEXP] [ -lbl ]
908 # Send a command to gdb; test the result.
910 # COMMAND is the command to execute, send to GDB with send_gdb. If
911 # this is the null string no command is sent.
912 # MESSAGE is a message to be printed with the built-in failure patterns
913 # if one of them matches. If MESSAGE is empty COMMAND will be used.
914 # -prompt PROMPT_REGEXP specifies a regexp matching the expected prompt
915 # after the command output. If empty, defaults to "$gdb_prompt $".
916 # -lbl specifies that line-by-line matching will be used.
917 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
918 # patterns. Pattern elements will be evaluated in the caller's
919 # context; action elements will be executed in the caller's context.
920 # Unlike patterns for gdb_test, these patterns should generally include
921 # the final newline and prompt.
924 # 1 if the test failed, according to a built-in failure pattern
925 # 0 if only user-supplied patterns matched
926 # -1 if there was an internal error.
928 # You can use this function thus:
930 # gdb_test_multiple "print foo" "test foo" {
931 # -re "expected output 1" {
934 # -re "expected output 2" {
939 # Within action elements you can also make use of the variable
940 # gdb_test_name. This variable is setup automatically by
941 # gdb_test_multiple, and contains the value of MESSAGE. You can then
942 # write this, which is equivalent to the above:
944 # gdb_test_multiple "print foo" "test foo" {
945 # -re "expected output 1" {
946 # pass $gdb_test_name
948 # -re "expected output 2" {
949 # fail $gdb_test_name
953 # Like with "expect", you can also specify the spawn id to match with
954 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
955 # $gdb_spawn_id. The former matches inferior I/O, while the latter
956 # matches GDB I/O. E.g.:
958 # send_inferior "hello\n"
959 # gdb_test_multiple "continue" "test echo" {
960 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
963 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
964 # fail "hit breakpoint"
968 # The standard patterns, such as "Inferior exited..." and "A problem
969 # ...", all being implicitly appended to that list. These are always
970 # expected from $gdb_spawn_id. IOW, callers do not need to worry
971 # about resetting "-i" back to $gdb_spawn_id explicitly.
973 # In EXPECT_ARGUMENTS we can use a -wrap pattern flag, that wraps the regexp
974 # pattern as gdb_test wraps its message argument.
975 # This allows us to rewrite:
976 # gdb_test <command> <pattern> <message>
978 # gdb_test_multiple <command> <message> {
979 # -re -wrap <pattern> {
980 # pass $gdb_test_name
984 # In EXPECT_ARGUMENTS, a pattern flag -early can be used. It makes sure the
985 # pattern is inserted before any implicit pattern added by gdb_test_multiple.
986 # Using this pattern flag, we can f.i. setup a kfail for an assertion failure
987 # <assert> during gdb_continue_to_breakpoint by the rewrite:
988 # gdb_continue_to_breakpoint <msg> <pattern>
990 # set breakpoint_pattern "(?:Breakpoint|Temporary breakpoint) .* (at|in)"
991 # gdb_test_multiple "continue" "continue to breakpoint: <msg>" {
992 # -early -re "internal-error: <assert>" {
993 # setup_kfail gdb/nnnnn "*-*-*"
996 # -re "$breakpoint_pattern <pattern>\r\n$gdb_prompt $" {
997 # pass $gdb_test_name
1001 proc gdb_test_multiple { command message args } {
1002 global verbose use_gdb_stub
1003 global gdb_prompt pagination_prompt
1006 global inferior_exited_re
1007 upvar timeout timeout
1008 upvar expect_out expect_out
1012 set prompt_regexp ""
1013 for {set i 0} {$i < [llength $args]} {incr i} {
1014 set arg [lindex $args $i]
1015 if { $arg == "-prompt" } {
1017 set prompt_regexp [lindex $args $i]
1018 } elseif { $arg == "-lbl" } {
1025 if { [expr $i + 1] < [llength $args] } {
1026 error "Too many arguments to gdb_test_multiple"
1027 } elseif { ![info exists user_code] } {
1028 error "Too few arguments to gdb_test_multiple"
1031 set prompt_regexp [fill_in_default_prompt $prompt_regexp true]
1033 if { $message == "" } {
1034 set message $command
1037 if [string match "*\[\r\n\]" $command] {
1038 error "Invalid trailing newline in \"$command\" command"
1041 if [string match "*\[\003\004\]" $command] {
1042 error "Invalid trailing control code in \"$command\" command"
1045 if [string match "*\[\r\n\]*" $message] {
1046 error "Invalid newline in \"$message\" test"
1050 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
1052 error "gdbserver does not support $command without extended-remote"
1055 # TCL/EXPECT WART ALERT
1056 # Expect does something very strange when it receives a single braced
1057 # argument. It splits it along word separators and performs substitutions.
1058 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
1059 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
1060 # double-quoted list item, "\[ab\]" is just a long way of representing
1061 # "[ab]", because the backslashes will be removed by lindex.
1063 # Unfortunately, there appears to be no easy way to duplicate the splitting
1064 # that expect will do from within TCL. And many places make use of the
1065 # "\[0-9\]" construct, so we need to support that; and some places make use
1066 # of the "[func]" construct, so we need to support that too. In order to
1067 # get this right we have to substitute quoted list elements differently
1068 # from braced list elements.
1070 # We do this roughly the same way that Expect does it. We have to use two
1071 # lists, because if we leave unquoted newlines in the argument to uplevel
1072 # they'll be treated as command separators, and if we escape newlines
1073 # we mangle newlines inside of command blocks. This assumes that the
1074 # input doesn't contain a pattern which contains actual embedded newlines
1077 regsub -all {\n} ${user_code} { } subst_code
1078 set subst_code [uplevel list $subst_code]
1080 set processed_code ""
1081 set early_processed_code ""
1082 # The variable current_list holds the name of the currently processed
1083 # list, either processed_code or early_processed_code.
1084 set current_list "processed_code"
1086 set expecting_action 0
1089 foreach item $user_code subst_item $subst_code {
1090 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
1091 lappend $current_list $item
1094 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
1095 lappend $current_list $item
1098 if { $item == "-early" } {
1099 set current_list "early_processed_code"
1102 if { $item == "-timeout" || $item == "-i" } {
1104 lappend $current_list $item
1107 if { $item == "-wrap" } {
1111 if { $expecting_arg } {
1113 lappend $current_list $subst_item
1116 if { $expecting_action } {
1117 lappend $current_list "uplevel [list $item]"
1118 set expecting_action 0
1119 # Cosmetic, no effect on the list.
1120 append $current_list "\n"
1121 # End the effect of -early, it only applies to one action.
1122 set current_list "processed_code"
1125 set expecting_action 1
1126 if { $wrap_pattern } {
1127 # Wrap subst_item as is done for the gdb_test PATTERN argument.
1128 lappend $current_list \
1129 "\[\r\n\]*(?:$subst_item)\[\r\n\]+$prompt_regexp"
1132 lappend $current_list $subst_item
1134 if {$patterns != ""} {
1135 append patterns "; "
1137 append patterns "\"$subst_item\""
1140 # Also purely cosmetic.
1141 regsub -all {\r} $patterns {\\r} patterns
1142 regsub -all {\n} $patterns {\\n} patterns
1145 send_user "Sending \"$command\" to gdb\n"
1146 send_user "Looking to match \"$patterns\"\n"
1147 send_user "Message is \"$message\"\n"
1151 set string "${command}\n"
1152 if { $command != "" } {
1153 set multi_line_re "\[\r\n\] *>"
1154 while { "$string" != "" } {
1155 set foo [string first "\n" "$string"]
1156 set len [string length "$string"]
1157 if { $foo < [expr $len - 1] } {
1158 set str [string range "$string" 0 $foo]
1159 if { [send_gdb "$str"] != "" } {
1160 verbose -log "Couldn't send $command to GDB."
1164 # since we're checking if each line of the multi-line
1165 # command are 'accepted' by GDB here,
1166 # we need to set -notransfer expect option so that
1167 # command output is not lost for pattern matching
1170 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
1171 timeout { verbose "partial: timeout" 3 }
1173 set string [string range "$string" [expr $foo + 1] end]
1174 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
1179 if { "$string" != "" } {
1180 if { [send_gdb "$string"] != "" } {
1181 verbose -log "Couldn't send $command to GDB."
1188 set code $early_processed_code
1190 -re ".*A problem internal to GDB has been detected" {
1191 fail "$message (GDB internal error)"
1192 gdb_internal_error_resync
1195 -re "\\*\\*\\* DOSEXIT code.*" {
1196 if { $message != "" } {
1201 -re "Corrupted shared library list.*$prompt_regexp" {
1202 fail "$message (shared library list corrupted)"
1205 -re "Invalid cast\.\r\nwarning: Probes-based dynamic linker interface failed.*$prompt_regexp" {
1206 fail "$message (probes interface failure)"
1210 append code $processed_code
1212 # Reset the spawn id, in case the processed code used -i.
1218 -re "Ending remote debugging.*$prompt_regexp" {
1220 warning "Can`t communicate to remote target."
1226 -re "Undefined\[a-z\]* command:.*$prompt_regexp" {
1227 perror "Undefined command \"$command\"."
1231 -re "Ambiguous command.*$prompt_regexp" {
1232 perror "\"$command\" is not a unique command name."
1236 -re "$inferior_exited_re with code \[0-9\]+.*$prompt_regexp" {
1237 if {![string match "" $message]} {
1238 set errmsg "$message (the program exited)"
1240 set errmsg "$command (the program exited)"
1245 -re "$inferior_exited_re normally.*$prompt_regexp" {
1246 if {![string match "" $message]} {
1247 set errmsg "$message (the program exited)"
1249 set errmsg "$command (the program exited)"
1254 -re "The program is not being run.*$prompt_regexp" {
1255 if {![string match "" $message]} {
1256 set errmsg "$message (the program is no longer running)"
1258 set errmsg "$command (the program is no longer running)"
1263 -re "\r\n$prompt_regexp" {
1264 if {![string match "" $message]} {
1269 -re "$pagination_prompt" {
1271 perror "Window too small."
1275 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
1276 send_gdb "n\n" answer
1277 gdb_expect -re "$prompt_regexp"
1278 fail "$message (got interactive prompt)"
1281 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
1283 gdb_expect -re "$prompt_regexp"
1284 fail "$message (got breakpoint menu)"
1290 perror "GDB process no longer exists"
1291 set wait_status [wait -i $gdb_spawn_id]
1292 verbose -log "GDB process exited with wait status $wait_status"
1293 if { $message != "" } {
1300 if {$line_by_line} {
1302 -re "\r\n\[^\r\n\]*(?=\r\n)" {
1308 # Now patterns that apply to any spawn id specified.
1312 perror "Process no longer exists"
1313 if { $message != "" } {
1319 perror "internal buffer is full."
1324 if {![string match "" $message]} {
1325 fail "$message (timeout)"
1331 # remote_expect calls the eof section if there is an error on the
1332 # expect call. We already have eof sections above, and we don't
1333 # want them to get called in that situation. Since the last eof
1334 # section becomes the error section, here we define another eof
1335 # section, but with an empty spawn_id list, so that it won't ever
1339 # This comment is here because the eof section must not be
1340 # the empty string, otherwise remote_expect won't realize
1345 # Create gdb_test_name in the parent scope. If this variable
1346 # already exists, which it might if we have nested calls to
1347 # gdb_test_multiple, then preserve the old value, otherwise,
1348 # create a new variable in the parent scope.
1349 upvar gdb_test_name gdb_test_name
1350 if { [info exists gdb_test_name] } {
1351 set gdb_test_name_old "$gdb_test_name"
1353 set gdb_test_name "$message"
1356 set code [catch {gdb_expect $code} string]
1358 # Clean up the gdb_test_name variable. If we had a
1359 # previous value then restore it, otherwise, delete the variable
1360 # from the parent scope.
1361 if { [info exists gdb_test_name_old] } {
1362 set gdb_test_name "$gdb_test_name_old"
1368 global errorInfo errorCode
1369 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1370 } elseif {$code > 1} {
1371 return -code $code $string
1376 # Usage: gdb_test_multiline NAME INPUT RESULT {INPUT RESULT} ...
1377 # Run a test named NAME, consisting of multiple lines of input.
1378 # After each input line INPUT, search for result line RESULT.
1379 # Succeed if all results are seen; fail otherwise.
1381 proc gdb_test_multiline { name args } {
1384 foreach {input result} $args {
1386 if {[gdb_test_multiple $input "$name: input $inputnr: $input" {
1387 -re "\[\r\n\]*($result)\[\r\n\]+($gdb_prompt | *>)$" {
1398 # gdb_test [-prompt PROMPT_REGEXP] [-lbl]
1399 # COMMAND [PATTERN] [MESSAGE] [QUESTION RESPONSE]
1400 # Send a command to gdb; test the result.
1402 # COMMAND is the command to execute, send to GDB with send_gdb. If
1403 # this is the null string no command is sent.
1404 # PATTERN is the pattern to match for a PASS, and must NOT include the
1405 # \r\n sequence immediately before the gdb prompt (see -nonl below).
1406 # This argument may be omitted to just match the prompt, ignoring
1407 # whatever output precedes it. If PATTERN starts with '^' then
1408 # PATTERN will be anchored such that it should match all output from
1410 # MESSAGE is an optional message to be printed. If this is
1411 # omitted, then the pass/fail messages use the command string as the
1412 # message. (If this is the empty string, then sometimes we don't
1413 # call pass or fail at all; I don't understand this at all.)
1414 # QUESTION is a question GDB should ask in response to COMMAND, like
1415 # "are you sure?" If this is specified, the test fails if GDB
1416 # doesn't print the question.
1417 # RESPONSE is the response to send when QUESTION appears.
1419 # -prompt PROMPT_REGEXP specifies a regexp matching the expected prompt
1420 # after the command output. If empty, defaults to "$gdb_prompt $".
1421 # -no-prompt-anchor specifies that if the default prompt regexp is used, it
1422 # should not be anchored at the end of the buffer. This means that the
1423 # pattern can match even if there is stuff output after the prompt. Does not
1424 # have any effect if -prompt is specified.
1425 # -lbl specifies that line-by-line matching will be used.
1426 # -nopass specifies that a PASS should not be issued.
1427 # -nonl specifies that no \r\n sequence is expected between PATTERN
1428 # and the gdb prompt.
1431 # 1 if the test failed,
1432 # 0 if the test passes,
1433 # -1 if there was an internal error.
1435 proc gdb_test { args } {
1437 upvar timeout timeout
1447 lassign $args command pattern message question response
1449 # Can't have a question without a response.
1450 if { $question != "" && $response == "" || [llength $args] > 5 } {
1451 error "Unexpected arguments: $args"
1454 if { $message == "" } {
1455 set message $command
1458 set prompt [fill_in_default_prompt $prompt [expr !${no-prompt-anchor}]]
1459 set nl [expr ${nonl} ? {""} : {"\r\n"}]
1463 # If the pattern starts with a '^' then we want to match all the
1464 # output from COMMAND. To support this, here we inject an
1465 # additional pattern that matches the command immediately after
1467 if {[string range $pattern 0 0] eq "^"} {
1468 set command_regex [string_to_regexp $command]
1469 set pattern [string range $pattern 1 end]
1470 if {$command_regex ne ""} {
1471 set pattern "^${command_regex}\r\n$pattern"
1477 -re "(?:$pattern)$nl$prompt" {
1478 if { $question != "" & !$saw_question} {
1480 } elseif {!$nopass} {
1486 if { $question != "" } {
1490 send_gdb "$response\n"
1496 set user_code [join $user_code]
1499 lappend opts "-prompt" "$prompt"
1504 return [gdb_test_multiple $command $message {*}$opts $user_code]
1507 # Return 1 if tcl version used is at least MAJOR.MINOR
1508 proc tcl_version_at_least { major minor } {
1510 regexp {^([0-9]+)\.([0-9]+)$} $tcl_version \
1511 dummy tcl_version_major tcl_version_minor
1512 return [version_compare [list $major $minor] \
1513 <= [list $tcl_version_major $tcl_version_minor]]
1516 if { [tcl_version_at_least 8 5] == 0 } {
1517 # lrepeat was added in tcl 8.5. Only add if missing.
1518 proc lrepeat { n element } {
1519 if { [string is integer -strict $n] == 0 } {
1520 error "expected integer but got \"$n\""
1523 error "bad count \"$n\": must be integer >= 0"
1526 for {set i 0} {$i < $n} {incr i} {
1527 lappend res $element
1533 if { [tcl_version_at_least 8 6] == 0 } {
1534 # lmap was added in tcl 8.6. Only add if missing.
1536 # Note that we only implement the simple variant for now.
1537 proc lmap { varname list body } {
1540 uplevel 1 "set $varname $val"
1541 lappend res [uplevel 1 $body]
1548 # gdb_test_no_output [-prompt PROMPT_REGEXP] [-nopass] COMMAND [MESSAGE]
1549 # Send a command to GDB and verify that this command generated no output.
1551 # See gdb_test for a description of the -prompt, -no-prompt-anchor, -nopass,
1552 # COMMAND, and MESSAGE parameters.
1555 # 1 if the test failed,
1556 # 0 if the test passes,
1557 # -1 if there was an internal error.
1559 proc gdb_test_no_output { args } {
1568 lassign $args command message
1570 set prompt [fill_in_default_prompt $prompt [expr !${no-prompt-anchor}]]
1572 set command_regex [string_to_regexp $command]
1573 return [gdb_test_multiple $command $message -prompt $prompt {
1574 -re "^$command_regex\r\n$prompt" {
1582 # Send a command and then wait for a sequence of outputs.
1583 # This is useful when the sequence is long and contains ".*", a single
1584 # regexp to match the entire output can get a timeout much easier.
1586 # COMMAND is the command to execute, send to GDB with send_gdb. If
1587 # this is the null string no command is sent.
1588 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1589 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1590 # processed in order, and all must be present in the output.
1592 # The -prompt switch can be used to override the prompt expected at the end of
1593 # the output sequence.
1595 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1596 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1597 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1599 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1600 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1603 # 1 if the test failed,
1604 # 0 if the test passes,
1605 # -1 if there was an internal error.
1607 proc gdb_test_sequence { args } {
1610 parse_args {{prompt ""}}
1612 if { $prompt == "" } {
1613 set prompt "$gdb_prompt $"
1616 if { [llength $args] != 3 } {
1617 error "Unexpected # of arguments, expecting: COMMAND TEST_NAME EXPECTED_OUTPUT_LIST"
1620 lassign $args command test_name expected_output_list
1622 if { $test_name == "" } {
1623 set test_name $command
1626 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1628 if { $command != "" } {
1629 send_gdb "$command\n"
1632 return [gdb_expect_list $test_name $prompt $expected_output_list]
1636 # Match output of COMMAND using RE. Read output line-by-line.
1637 # Report pass/fail with MESSAGE.
1638 # For a command foo with output:
1643 # the portion matched using RE is:
1648 # Optionally, additional -re-not <regexp> arguments can be specified, to
1649 # ensure that a regexp is not match by the COMMAND output.
1650 # Such an additional argument generates an additional PASS/FAIL of the form:
1651 # PASS: test-case.exp: $message: pattern not matched: <regexp>
1653 proc gdb_test_lines { command message re args } {
1656 for {set i 0} {$i < [llength $args]} {incr i} {
1657 set arg [lindex $args $i]
1658 if { $arg == "-re-not" } {
1660 if { [llength $args] == $i } {
1661 error "Missing argument for -re-not"
1664 set arg [lindex $args $i]
1667 error "Unhandled argument: $arg"
1671 if { $message == ""} {
1672 set message $command
1676 gdb_test_multiple $command $message {
1677 -re "\r\n(\[^\r\n\]*)(?=\r\n)" {
1678 set line $expect_out(1,string)
1679 if { $lines eq "" } {
1680 append lines "$line"
1682 append lines "\r\n$line"
1691 gdb_assert { [regexp $re $lines] } $message
1693 foreach re $re_not {
1694 gdb_assert { ![regexp $re $lines] } "$message: pattern not matched: $re"
1698 # Test that a command gives an error. For pass or fail, return
1699 # a 1 to indicate that more tests can proceed. However a timeout
1700 # is a serious error, generates a special fail message, and causes
1701 # a 0 to be returned to indicate that more tests are likely to fail
1704 proc test_print_reject { args } {
1708 if {[llength $args] == 2} {
1709 set expectthis [lindex $args 1]
1711 set expectthis "should never match this bogus string"
1713 set sendthis [lindex $args 0]
1715 send_user "Sending \"$sendthis\" to gdb\n"
1716 send_user "Looking to match \"$expectthis\"\n"
1718 send_gdb "$sendthis\n"
1719 #FIXME: Should add timeout as parameter.
1721 -re "A .* in expression.*\\.*$gdb_prompt $" {
1722 pass "reject $sendthis"
1725 -re "Invalid syntax in expression.*$gdb_prompt $" {
1726 pass "reject $sendthis"
1729 -re "Junk after end of expression.*$gdb_prompt $" {
1730 pass "reject $sendthis"
1733 -re "Invalid number.*$gdb_prompt $" {
1734 pass "reject $sendthis"
1737 -re "Invalid character constant.*$gdb_prompt $" {
1738 pass "reject $sendthis"
1741 -re "No symbol table is loaded.*$gdb_prompt $" {
1742 pass "reject $sendthis"
1745 -re "No symbol .* in current context.*$gdb_prompt $" {
1746 pass "reject $sendthis"
1749 -re "Unmatched single quote.*$gdb_prompt $" {
1750 pass "reject $sendthis"
1753 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1754 pass "reject $sendthis"
1757 -re "$expectthis.*$gdb_prompt $" {
1758 pass "reject $sendthis"
1761 -re ".*$gdb_prompt $" {
1762 fail "reject $sendthis"
1766 fail "reject $sendthis (eof or timeout)"
1773 # Same as gdb_test, but the second parameter is not a regexp,
1774 # but a string that must match exactly.
1776 proc gdb_test_exact { args } {
1777 upvar timeout timeout
1779 set command [lindex $args 0]
1781 # This applies a special meaning to a null string pattern. Without
1782 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1783 # messages from commands that should have no output except a new
1784 # prompt. With this, only results of a null string will match a null
1787 set pattern [lindex $args 1]
1788 if [string match $pattern ""] {
1789 set pattern [string_to_regexp [lindex $args 0]]
1791 set pattern [string_to_regexp [lindex $args 1]]
1794 # It is most natural to write the pattern argument with only
1795 # embedded \n's, especially if you are trying to avoid Tcl quoting
1796 # problems. But gdb_expect really wants to see \r\n in patterns. So
1797 # transform the pattern here. First transform \r\n back to \n, in
1798 # case some users of gdb_test_exact already do the right thing.
1799 regsub -all "\r\n" $pattern "\n" pattern
1800 regsub -all "\n" $pattern "\r\n" pattern
1801 if {[llength $args] == 3} {
1802 set message [lindex $args 2]
1803 return [gdb_test $command $pattern $message]
1806 return [gdb_test $command $pattern]
1809 # Wrapper around gdb_test_multiple that looks for a list of expected
1810 # output elements, but which can appear in any order.
1811 # CMD is the gdb command.
1812 # NAME is the name of the test.
1813 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1815 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1816 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1817 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1819 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1820 # of text per element and then strip trailing \r\n's.
1822 # gdb_test_list_exact "foo" "bar" \
1823 # "\[^\r\n\]+\[\r\n\]+" \
1826 # {expected result 1} \
1827 # {expected result 2} \
1830 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1833 set matches [lsort $result_match_list]
1835 gdb_test_multiple $cmd $name {
1836 "$cmd\[\r\n\]" { exp_continue }
1837 -re $elm_find_regexp {
1838 set str $expect_out(0,string)
1839 verbose -log "seen: $str" 3
1840 regexp -- $elm_extract_regexp $str elm_seen
1841 verbose -log "extracted: $elm_seen" 3
1842 lappend seen $elm_seen
1845 -re "$gdb_prompt $" {
1847 foreach got [lsort $seen] have $matches {
1848 if {![string equal $got $have]} {
1853 if {[string length $failed] != 0} {
1854 fail "$name ($failed not found)"
1862 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1863 # Send a command to gdb; expect inferior and gdb output.
1865 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1868 # INFERIOR_PATTERN is the pattern to match against inferior output.
1870 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1871 # include the \r\n sequence immediately before the gdb prompt, nor the
1872 # prompt. The default is empty.
1874 # Both inferior and gdb patterns must match for a PASS.
1876 # If MESSAGE is ommitted, then COMMAND will be used as the message.
1879 # 1 if the test failed,
1880 # 0 if the test passes,
1881 # -1 if there was an internal error.
1884 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1885 global inferior_spawn_id gdb_spawn_id
1888 if {$message == ""} {
1889 set message $command
1892 set inferior_matched 0
1895 # Use an indirect spawn id list, and remove the inferior spawn id
1896 # from the expected output as soon as it matches, in case
1897 # $inferior_pattern happens to be a prefix of the resulting full
1898 # gdb pattern below (e.g., "\r\n").
1899 global gdb_test_stdio_spawn_id_list
1900 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1902 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1903 # then we may see gdb's output arriving before the inferior's
1905 set res [gdb_test_multiple $command $message {
1906 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1907 set inferior_matched 1
1908 if {!$gdb_matched} {
1909 set gdb_test_stdio_spawn_id_list ""
1913 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1915 if {!$inferior_matched} {
1923 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1928 # Wrapper around gdb_test_multiple to be used when testing expression
1929 # evaluation while 'set debug expression 1' is in effect.
1930 # Looks for some patterns that indicates the expression was rejected.
1932 # CMD is the command to execute, which should include an expression
1933 # that GDB will need to parse.
1935 # OUTPUT is the expected output pattern.
1937 # TESTNAME is the name to be used for the test, defaults to CMD if not
1939 proc gdb_test_debug_expr { cmd output {testname "" }} {
1942 if { ${testname} == "" } {
1946 gdb_test_multiple $cmd $testname {
1947 -re ".*Invalid expression.*\r\n$gdb_prompt $" {
1950 -re ".*\[\r\n\]$output\r\n$gdb_prompt $" {
1956 # get_print_expr_at_depths EXP OUTPUTS
1958 # Used for testing 'set print max-depth'. Prints the expression EXP
1959 # with 'set print max-depth' set to various depths. OUTPUTS is a list
1960 # of `n` different patterns to match at each of the depths from 0 to
1963 # This proc does one final check with the max-depth set to 'unlimited'
1964 # which is tested against the last pattern in the OUTPUTS list. The
1965 # OUTPUTS list is therefore required to match every depth from 0 to a
1966 # depth where the whole of EXP is printed with no ellipsis.
1968 # This proc leaves the 'set print max-depth' set to 'unlimited'.
1969 proc gdb_print_expr_at_depths {exp outputs} {
1970 for { set depth 0 } { $depth <= [llength $outputs] } { incr depth } {
1971 if { $depth == [llength $outputs] } {
1972 set expected_result [lindex $outputs [expr [llength $outputs] - 1]]
1973 set depth_string "unlimited"
1975 set expected_result [lindex $outputs $depth]
1976 set depth_string $depth
1979 with_test_prefix "exp='$exp': depth=${depth_string}" {
1980 gdb_test_no_output "set print max-depth ${depth_string}"
1981 gdb_test "p $exp" "$expected_result"
1988 # Issue a PASS and return true if evaluating CONDITION in the caller's
1989 # frame returns true, and issue a FAIL and return false otherwise.
1990 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1991 # omitted or is empty, then the pass/fail messages use the condition
1992 # string as the message.
1994 proc gdb_assert { condition {message ""} } {
1995 if { $message == ""} {
1996 set message $condition
1999 set code [catch {uplevel 1 [list expr $condition]} res]
2001 # If code is 1 (TCL_ERROR), it means evaluation failed and res contains
2002 # an error message. Print the error message, and set res to 0 since we
2003 # want to return a boolean.
2004 warning "While evaluating expression in gdb_assert: $res"
2007 } elseif { !$res } {
2015 proc gdb_reinitialize_dir { subdir } {
2018 if [is_remote host] {
2023 -re "Reinitialize source path to empty.*y or n. " {
2024 send_gdb "y\n" answer
2026 -re "Source directories searched.*$gdb_prompt $" {
2027 send_gdb "dir $subdir\n"
2029 -re "Source directories searched.*$gdb_prompt $" {
2030 verbose "Dir set to $subdir"
2032 -re "$gdb_prompt $" {
2033 perror "Dir \"$subdir\" failed."
2037 -re "$gdb_prompt $" {
2038 perror "Dir \"$subdir\" failed."
2042 -re "$gdb_prompt $" {
2043 perror "Dir \"$subdir\" failed."
2049 # gdb_exit -- exit the GDB, killing the target program if necessary
2051 proc default_gdb_exit {} {
2053 global INTERNAL_GDBFLAGS GDBFLAGS
2054 global gdb_spawn_id inferior_spawn_id
2055 global inotify_log_file
2057 if ![info exists gdb_spawn_id] {
2061 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
2063 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
2064 set fd [open $inotify_log_file]
2065 set data [read -nonewline $fd]
2068 if {[string compare $data ""] != 0} {
2069 warning "parallel-unsafe file creations noticed"
2072 set fd [open $inotify_log_file w]
2077 if { [is_remote host] && [board_info host exists fileid] } {
2081 send_gdb "y\n" answer
2084 -re "DOSEXIT code" { }
2089 if ![is_remote host] {
2093 unset ::gdb_tty_name
2094 unset inferior_spawn_id
2097 # Load a file into the debugger.
2098 # The return value is 0 for success, -1 for failure.
2100 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
2101 # to one of these values:
2103 # debug file was loaded successfully and has debug information
2104 # nodebug file was loaded successfully and has no debug information
2105 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
2107 # fail file was not loaded
2109 # This procedure also set the global variable GDB_FILE_CMD_MSG to the
2110 # output of the file command in case of success.
2112 # I tried returning this information as part of the return value,
2113 # but ran into a mess because of the many re-implementations of
2114 # gdb_load in config/*.exp.
2116 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
2117 # this if they can get more information set.
2119 proc gdb_file_cmd { arg } {
2122 global last_loaded_file
2124 # GCC for Windows target may create foo.exe given "-o foo".
2125 if { ![file exists $arg] && [file exists "$arg.exe"] } {
2129 # Save this for the benefit of gdbserver-support.exp.
2130 set last_loaded_file $arg
2132 # Set whether debug info was found.
2133 # Default to "fail".
2134 global gdb_file_cmd_debug_info gdb_file_cmd_msg
2135 set gdb_file_cmd_debug_info "fail"
2137 if [is_remote host] {
2138 set arg [remote_download host $arg]
2140 perror "download failed"
2145 # The file command used to kill the remote target. For the benefit
2146 # of the testsuite, preserve this behavior. Mark as optional so it doesn't
2147 # get written to the stdin log.
2148 send_gdb "kill\n" optional
2150 -re "Kill the program being debugged. .y or n. $" {
2151 send_gdb "y\n" answer
2152 verbose "\t\tKilling previous program being debugged"
2155 -re "$gdb_prompt $" {
2160 send_gdb "file $arg\n"
2161 set new_symbol_table 0
2162 set basename [file tail $arg]
2164 -re "(Reading symbols from.*LZMA support was disabled.*$gdb_prompt $)" {
2165 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
2166 set gdb_file_cmd_msg $expect_out(1,string)
2167 set gdb_file_cmd_debug_info "lzma"
2170 -re "(Reading symbols from.*No debugging symbols found.*$gdb_prompt $)" {
2171 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
2172 set gdb_file_cmd_msg $expect_out(1,string)
2173 set gdb_file_cmd_debug_info "nodebug"
2176 -re "(Reading symbols from.*$gdb_prompt $)" {
2177 verbose "\t\tLoaded $arg into $GDB"
2178 set gdb_file_cmd_msg $expect_out(1,string)
2179 set gdb_file_cmd_debug_info "debug"
2182 -re "Load new symbol table from \".*\".*y or n. $" {
2183 if { $new_symbol_table > 0 } {
2184 perror [join [list "Couldn't load $basename,"
2185 "interactive prompt loop detected."]]
2188 send_gdb "y\n" answer
2189 incr new_symbol_table
2190 set suffix "-- with new symbol table"
2191 set arg "$arg $suffix"
2192 set basename "$basename $suffix"
2195 -re "No such file or directory.*$gdb_prompt $" {
2196 perror "($basename) No such file or directory"
2199 -re "A problem internal to GDB has been detected" {
2200 perror "Couldn't load $basename into GDB (GDB internal error)."
2201 gdb_internal_error_resync
2204 -re "$gdb_prompt $" {
2205 perror "Couldn't load $basename into GDB."
2209 perror "Couldn't load $basename into GDB (timeout)."
2213 # This is an attempt to detect a core dump, but seems not to
2214 # work. Perhaps we need to match .* followed by eof, in which
2215 # gdb_expect does not seem to have a way to do that.
2216 perror "Couldn't load $basename into GDB (eof)."
2222 # The expect "spawn" function puts the tty name into the spawn_out
2223 # array; but dejagnu doesn't export this globally. So, we have to
2224 # wrap spawn with our own function and poke in the built-in spawn
2225 # so that we can capture this value.
2227 # If available, the TTY name is saved to the LAST_SPAWN_TTY_NAME global.
2228 # Otherwise, LAST_SPAWN_TTY_NAME is unset.
2230 proc spawn_capture_tty_name { args } {
2231 set result [uplevel builtin_spawn $args]
2232 upvar spawn_out spawn_out
2233 if { [info exists spawn_out(slave,name)] } {
2234 set ::last_spawn_tty_name $spawn_out(slave,name)
2236 # If a process is spawned as part of a pipe line (e.g. passing
2237 # -leaveopen to the spawn proc) then the spawned process is no
2238 # assigned a tty and spawn_out(slave,name) will not be set.
2239 # In that case we want to ensure that last_spawn_tty_name is
2242 # If the previous process spawned was also not assigned a tty
2243 # (e.g. multiple processed chained in a pipeline) then
2244 # last_spawn_tty_name will already be unset, so, if we don't
2245 # use -nocomplain here we would otherwise get an error.
2246 unset -nocomplain ::last_spawn_tty_name
2251 rename spawn builtin_spawn
2252 rename spawn_capture_tty_name spawn
2254 # Default gdb_spawn procedure.
2256 proc default_gdb_spawn { } {
2259 global INTERNAL_GDBFLAGS GDBFLAGS
2262 # Set the default value, it may be overriden later by specific testfile.
2264 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
2265 # is already started after connecting and run/attach are not supported.
2266 # This is used for the "remote" protocol. After GDB starts you should
2267 # check global $use_gdb_stub instead of the board as the testfile may force
2268 # a specific different target protocol itself.
2269 set use_gdb_stub [target_info exists use_gdb_stub]
2271 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
2272 gdb_write_cmd_file "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
2274 if [info exists gdb_spawn_id] {
2278 if ![is_remote host] {
2279 if {[which $GDB] == 0} {
2280 perror "$GDB does not exist."
2285 # Put GDBFLAGS last so that tests can put "--args ..." in it.
2286 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS [host_info gdb_opts] $GDBFLAGS"]
2287 if { $res < 0 || $res == "" } {
2288 perror "Spawning $GDB failed."
2292 set gdb_spawn_id $res
2293 set ::gdb_tty_name $::last_spawn_tty_name
2297 # Default gdb_start procedure.
2299 proc default_gdb_start { } {
2302 global inferior_spawn_id
2304 if [info exists gdb_spawn_id] {
2308 # Keep track of the number of times GDB has been launched.
2309 global gdb_instances
2319 # Default to assuming inferior I/O is done on GDB's terminal.
2320 if {![info exists inferior_spawn_id]} {
2321 set inferior_spawn_id $gdb_spawn_id
2324 # When running over NFS, particularly if running many simultaneous
2325 # tests on different hosts all using the same server, things can
2326 # get really slow. Give gdb at least 3 minutes to start up.
2328 -re "\[\r\n\]$gdb_prompt $" {
2329 verbose "GDB initialized."
2331 -re "\[\r\n\]\033\\\[.2004h$gdb_prompt $" {
2332 # This special case detects what happens when GDB is
2333 # started with bracketed paste mode enabled. This mode is
2334 # usually forced off (see setting of INPUTRC in
2335 # default_gdb_init), but for at least one test we turn
2336 # bracketed paste mode back on, and then start GDB. In
2337 # that case, this case is hit.
2338 verbose "GDB initialized."
2340 -re "^$gdb_prompt $" {
2342 verbose "GDB initialized."
2344 -re "^\033\\\[.2004h$gdb_prompt $" {
2345 # Output with -q, and bracketed paste mode enabled, see above.
2346 verbose "GDB initialized."
2348 -re "$gdb_prompt $" {
2349 perror "GDB never initialized."
2354 perror "(timeout) GDB never initialized after 10 seconds."
2360 perror "(eof) GDB never initialized."
2366 # force the height to "unlimited", so no pagers get used
2368 send_gdb "set height 0\n"
2370 -re "$gdb_prompt $" {
2371 verbose "Setting height to 0." 2
2374 warning "Couldn't set the height to 0"
2377 # force the width to "unlimited", so no wraparound occurs
2378 send_gdb "set width 0\n"
2380 -re "$gdb_prompt $" {
2381 verbose "Setting width to 0." 2
2384 warning "Couldn't set the width to 0."
2392 # Utility procedure to give user control of the gdb prompt in a script. It is
2393 # meant to be used for debugging test cases, and should not be left in the
2396 proc gdb_interact { } {
2398 set spawn_id $gdb_spawn_id
2400 send_user "+------------------------------------------+\n"
2401 send_user "| Script interrupted, you can now interact |\n"
2402 send_user "| with by gdb. Type >>> to continue. |\n"
2403 send_user "+------------------------------------------+\n"
2410 # Examine the output of compilation to determine whether compilation
2411 # failed or not. If it failed determine whether it is due to missing
2412 # compiler or due to compiler error. Report pass, fail or unsupported
2415 proc gdb_compile_test {src output} {
2416 set msg "compilation [file tail $src]"
2418 if { $output == "" } {
2423 if { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output]
2424 || [regexp {.*: command not found[\r|\n]*$} $output]
2425 || [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
2426 unsupported "$msg (missing compiler)"
2430 set gcc_re ".*: error: unrecognized command line option "
2431 set clang_re ".*: error: unsupported option "
2432 if { [regexp "(?:$gcc_re|$clang_re)(\[^ \t;\r\n\]*)" $output dummy option]
2433 && $option != "" } {
2434 unsupported "$msg (unsupported option $option)"
2438 # Unclassified compilation failure, be more verbose.
2439 verbose -log "compilation failed: $output" 2
2443 # Return a 1 for configurations for which we want to try to test C++.
2445 proc allow_cplus_tests {} {
2446 if { [istarget "h8300-*-*"] } {
2450 # The C++ IO streams are too large for HC11/HC12 and are thus not
2451 # available. The gdb C++ tests use them and don't compile.
2452 if { [istarget "m6811-*-*"] } {
2455 if { [istarget "m6812-*-*"] } {
2461 # Return a 0 for configurations which are missing either C++ or the STL.
2463 proc allow_stl_tests {} {
2464 return [allow_cplus_tests]
2467 # Return a 1 if I want to try to test FORTRAN.
2469 proc allow_fortran_tests {} {
2473 # Return a 1 if I want to try to test ada.
2475 proc allow_ada_tests {} {
2476 if { [is_remote host] } {
2477 # Currently gdb_ada_compile doesn't support remote host.
2483 # Return a 1 if I want to try to test GO.
2485 proc allow_go_tests {} {
2489 # Return a 1 if I even want to try to test D.
2491 proc allow_d_tests {} {
2495 # Return a 1 if we can compile source files in LANG.
2497 gdb_caching_proc can_compile { lang } {
2499 if { $lang == "d" } {
2500 set src { void main() {} }
2501 return [gdb_can_simple_compile can_compile_$lang $src executable {d}]
2504 if { $lang == "rust" } {
2505 if { ![isnative] } {
2509 if { [is_remote host] } {
2510 # Proc find_rustc returns "" for remote host.
2514 # The rust compiler does not support "-m32", skip.
2515 global board board_info
2516 set board [target_info name]
2517 if {[board_info $board exists multilib_flags]} {
2518 foreach flag [board_info $board multilib_flags] {
2519 if { $flag == "-m32" } {
2525 set src { fn main() {} }
2526 # Drop nowarnings in default_compile_flags, it translates to -w which
2527 # rustc doesn't support.
2528 return [gdb_can_simple_compile can_compile_$lang $src executable \
2529 {rust} {debug quiet}]
2532 error "can_compile doesn't support lang: $lang"
2535 # Return 1 to try Rust tests, 0 to skip them.
2536 proc allow_rust_tests {} {
2540 # Return a 1 for configurations that support Python scripting.
2542 gdb_caching_proc allow_python_tests {} {
2543 set output [remote_exec host $::GDB "$::INTERNAL_GDBFLAGS --configuration"]
2544 return [expr {[string first "--with-python" $output] != -1}]
2547 gdb_caching_proc allow_dap_tests {} {
2548 if { ![allow_python_tests] } {
2552 # ton.tcl uses "string is entier", supported starting tcl 8.6.
2553 if { ![tcl_version_at_least 8 6] } {
2557 # With set auto-connect-native-target off, we run into:
2559 # Traceback (most recent call last):
2560 # File "startup.py", line <n>, in exec_and_log
2561 # output = gdb.execute(cmd, from_tty=True, to_string=True)
2562 # gdb.error: Don't know how to run. Try "help target".
2563 set gdb_flags [join $::GDBFLAGS $::INTERNAL_GDBFLAGS]
2564 return [expr {[string first "set auto-connect-native-target off" $gdb_flags] == -1}]
2567 # Return a 1 if we should run shared library tests.
2569 proc allow_shlib_tests {} {
2570 # Run the shared library tests on native systems.
2575 # An abbreviated list of remote targets where we should be able to
2576 # run shared library tests.
2577 if {([istarget *-*-linux*]
2578 || [istarget *-*-*bsd*]
2579 || [istarget *-*-solaris2*]
2580 || [istarget *-*-mingw*]
2581 || [istarget *-*-cygwin*]
2582 || [istarget *-*-pe*])} {
2589 # Return 1 if we should run dlmopen tests, 0 if we should not.
2591 gdb_caching_proc allow_dlmopen_tests {} {
2592 global srcdir subdir gdb_prompt inferior_exited_re
2594 # We need shared library support.
2595 if { ![allow_shlib_tests] } {
2599 set me "allow_dlmopen_tests"
2613 struct r_debug *r_debug;
2617 /* The version is kept at 1 until we create a new namespace. */
2618 handle = dlmopen (LM_ID_NEWLM, DSO_NAME, RTLD_LAZY | RTLD_LOCAL);
2620 printf ("dlmopen failed: %s.\n", dlerror ());
2625 /* Taken from /usr/include/link.h. */
2626 for (dyn = _DYNAMIC; dyn->d_tag != DT_NULL; ++dyn)
2627 if (dyn->d_tag == DT_DEBUG)
2628 r_debug = (struct r_debug *) dyn->d_un.d_ptr;
2631 printf ("r_debug not found.\n");
2634 if (r_debug->r_version < 2) {
2635 printf ("dlmopen debug not supported.\n");
2638 printf ("dlmopen debug supported.\n");
2643 set libsrc [standard_temp_file "libfoo.c"]
2644 set libout [standard_temp_file "libfoo.so"]
2645 gdb_produce_source $libsrc $lib
2647 if { [gdb_compile_shlib $libsrc $libout {debug}] != "" } {
2648 verbose -log "failed to build library"
2651 if { ![gdb_simple_compile $me $src executable \
2652 [list shlib_load debug \
2653 additional_flags=-DDSO_NAME=\"$libout\"]] } {
2654 verbose -log "failed to build executable"
2660 gdb_reinitialize_dir $srcdir/$subdir
2663 if { [gdb_run_cmd] != 0 } {
2664 verbose -log "failed to start skip test"
2668 -re "$inferior_exited_re normally.*${gdb_prompt} $" {
2669 set allow_dlmopen_tests 1
2671 -re "$inferior_exited_re with code.*${gdb_prompt} $" {
2672 set allow_dlmopen_tests 0
2675 warning "\n$me: default case taken"
2676 set allow_dlmopen_tests 0
2681 verbose "$me: returning $allow_dlmopen_tests" 2
2682 return $allow_dlmopen_tests
2685 # Return 1 if we should allow TUI-related tests.
2687 gdb_caching_proc allow_tui_tests {} {
2688 set output [remote_exec host $::GDB "$::INTERNAL_GDBFLAGS --configuration"]
2689 return [expr {[string first "--enable-tui" $output] != -1}]
2692 # Test files shall make sure all the test result lines in gdb.sum are
2693 # unique in a test run, so that comparing the gdb.sum files of two
2694 # test runs gives correct results. Test files that exercise
2695 # variations of the same tests more than once, shall prefix the
2696 # different test invocations with different identifying strings in
2697 # order to make them unique.
2699 # About test prefixes:
2701 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
2702 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
2703 # underlined substring in
2705 # PASS: gdb.base/mytest.exp: some test
2706 # ^^^^^^^^^^^^^^^^^^^^
2710 # The easiest way to adjust the test prefix is to append a test
2711 # variation prefix to the $pf_prefix, using the with_test_prefix
2714 # proc do_tests {} {
2715 # gdb_test ... ... "test foo"
2716 # gdb_test ... ... "test bar"
2718 # with_test_prefix "subvariation a" {
2719 # gdb_test ... ... "test x"
2722 # with_test_prefix "subvariation b" {
2723 # gdb_test ... ... "test x"
2727 # with_test_prefix "variation1" {
2728 # ...do setup for variation 1...
2732 # with_test_prefix "variation2" {
2733 # ...do setup for variation 2...
2739 # PASS: gdb.base/mytest.exp: variation1: test foo
2740 # PASS: gdb.base/mytest.exp: variation1: test bar
2741 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
2742 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
2743 # PASS: gdb.base/mytest.exp: variation2: test foo
2744 # PASS: gdb.base/mytest.exp: variation2: test bar
2745 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
2746 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
2748 # If for some reason more flexibility is necessary, one can also
2749 # manipulate the pf_prefix global directly, treating it as a string.
2753 # set saved_pf_prefix
2754 # append pf_prefix "${foo}: bar"
2755 # ... actual tests ...
2756 # set pf_prefix $saved_pf_prefix
2759 # Run BODY in the context of the caller, with the current test prefix
2760 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
2761 # Returns the result of BODY.
2763 proc with_test_prefix { prefix body } {
2766 set saved $pf_prefix
2767 append pf_prefix " " $prefix ":"
2768 set code [catch {uplevel 1 $body} result]
2769 set pf_prefix $saved
2772 global errorInfo errorCode
2773 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2775 return -code $code $result
2779 # Wrapper for foreach that calls with_test_prefix on each iteration,
2780 # including the iterator's name and current value in the prefix.
2782 proc foreach_with_prefix {var list body} {
2784 foreach myvar $list {
2785 with_test_prefix "$var=$myvar" {
2786 set code [catch {uplevel 1 $body} result]
2790 global errorInfo errorCode
2791 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2792 } elseif {$code == 3} {
2794 } elseif {$code == 2} {
2795 return -code $code $result
2800 # Like TCL's native proc, but defines a procedure that wraps its body
2801 # within 'with_test_prefix "$proc_name" { ... }'.
2802 proc proc_with_prefix {name arguments body} {
2803 # Define the advertised proc.
2804 proc $name $arguments [list with_test_prefix $name $body]
2807 # Return an id corresponding to the test prefix stored in $pf_prefix, which
2808 # is more suitable for use in a file name.
2809 # F.i., for a pf_prefix:
2810 # gdb.dwarf2/dw2-lines.exp: \
2811 # cv=5: cdw=64: lv=5: ldw=64: string_form=line_strp:
2813 # cv-5-cdw-32-lv-5-ldw-64-string_form-line_strp
2819 # Strip ".exp: " prefix.
2820 set id [regsub {.*\.exp: } $id {}]
2822 # Strip colon suffix.
2823 set id [regsub {:$} $id {}]
2826 set id [regsub -all { } $id {}]
2828 # Replace colons, equal signs.
2829 set id [regsub -all \[:=\] $id -]
2834 # Run BODY in the context of the caller. After BODY is run, the variables
2835 # listed in VARS will be reset to the values they had before BODY was run.
2837 # This is useful for providing a scope in which it is safe to temporarily
2838 # modify global variables, e.g.
2840 # global INTERNAL_GDBFLAGS
2843 # set foo GDBHISTSIZE
2845 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2846 # append INTERNAL_GDBFLAGS " -nx"
2847 # unset -nocomplain env(GDBHISTSIZE)
2852 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2853 # modified inside BODY, this proc guarantees that the modifications will be
2854 # undone after BODY finishes executing.
2856 proc save_vars { vars body } {
2857 array set saved_scalars { }
2858 array set saved_arrays { }
2862 # First evaluate VAR in the context of the caller in case the variable
2863 # name may be a not-yet-interpolated string like env($foo)
2864 set var [uplevel 1 list $var]
2866 if [uplevel 1 [list info exists $var]] {
2867 if [uplevel 1 [list array exists $var]] {
2868 set saved_arrays($var) [uplevel 1 [list array get $var]]
2870 set saved_scalars($var) [uplevel 1 [list set $var]]
2873 lappend unset_vars $var
2877 set code [catch {uplevel 1 $body} result]
2879 foreach {var value} [array get saved_scalars] {
2880 uplevel 1 [list set $var $value]
2883 foreach {var value} [array get saved_arrays] {
2884 uplevel 1 [list unset $var]
2885 uplevel 1 [list array set $var $value]
2888 foreach var $unset_vars {
2889 uplevel 1 [list unset -nocomplain $var]
2893 global errorInfo errorCode
2894 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2896 return -code $code $result
2900 # As save_vars, but for variables stored in the board_info for the
2905 # save_target_board_info { multilib_flags } {
2907 # set board [target_info name]
2908 # unset_board_info multilib_flags
2909 # set_board_info multilib_flags "$multilib_flags"
2913 proc save_target_board_info { vars body } {
2914 global board board_info
2915 set board [target_info name]
2917 array set saved_target_board_info { }
2918 set unset_target_board_info { }
2921 if { [info exists board_info($board,$var)] } {
2922 set saved_target_board_info($var) [board_info $board $var]
2924 lappend unset_target_board_info $var
2928 set code [catch {uplevel 1 $body} result]
2930 foreach {var value} [array get saved_target_board_info] {
2931 unset_board_info $var
2932 set_board_info $var $value
2935 foreach var $unset_target_board_info {
2936 unset_board_info $var
2940 global errorInfo errorCode
2941 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2943 return -code $code $result
2947 # Run tests in BODY with the current working directory (CWD) set to
2948 # DIR. When BODY is finished, restore the original CWD. Return the
2951 # This procedure doesn't check if DIR is a valid directory, so you
2952 # have to make sure of that.
2954 proc with_cwd { dir body } {
2956 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2959 set code [catch {uplevel 1 $body} result]
2961 verbose -log "Switching back to $saved_dir."
2965 global errorInfo errorCode
2966 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2968 return -code $code $result
2972 # Use GDB's 'cd' command to switch to DIR. Return true if the switch
2973 # was successful, otherwise, call perror and return false.
2975 proc gdb_cd { dir } {
2977 gdb_test_multiple "cd $dir" "" {
2978 -re "^cd \[^\r\n\]+\r\n" {
2982 -re "^Working directory (\[^\r\n\]+)\\.\r\n" {
2983 set new_dir $expect_out(1,string)
2987 -re "^$::gdb_prompt $" {
2988 if { $new_dir == "" || $new_dir != $dir } {
2989 perror "failed to switch to $dir"
2998 # Use GDB's 'pwd' command to figure out the current working directory.
2999 # Return the directory as a string. If we can't figure out the
3000 # current working directory, then call perror, and return the empty
3005 gdb_test_multiple "pwd" "" {
3010 -re "^Working directory (\[^\r\n\]+)\\.\r\n" {
3011 set dir $expect_out(1,string)
3015 -re "^$::gdb_prompt $" {
3020 perror "failed to read GDB's current working directory"
3026 # Similar to the with_cwd proc, this proc runs BODY with the current
3027 # working directory changed to CWD.
3029 # Unlike with_cwd, the directory change here is done within GDB
3030 # itself, so GDB must be running before this proc is called.
3032 proc with_gdb_cwd { dir body } {
3033 set saved_dir [gdb_pwd]
3034 if { $saved_dir == "" } {
3038 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
3043 set code [catch {uplevel 1 $body} result]
3045 verbose -log "Switching back to $saved_dir."
3046 if ![gdb_cd $saved_dir] {
3050 # Check that GDB is still alive. If GDB crashed in the above code
3051 # then any corefile will have been left in DIR, not the root
3052 # testsuite directory. As a result the corefile will not be
3053 # brought to the users attention. Instead, if GDB crashed, then
3054 # this check should cause a FAIL, which should be enough to alert
3056 set saw_result false
3057 gdb_test_multiple "p 123" "" {
3062 -re "^\\\$$::decimal = 123\r\n" {
3067 -re "^$::gdb_prompt $" {
3068 if { !$saw_result } {
3069 fail "check gdb is alive in with_gdb_cwd"
3075 global errorInfo errorCode
3076 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3078 return -code $code $result
3082 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
3083 # PROMPT. When BODY is finished, restore GDB prompt and variable
3085 # Returns the result of BODY.
3089 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
3090 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
3091 # TCL). PROMPT is internally converted to a suitable regexp for matching.
3092 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
3093 # a) It's more intuitive for callers to pass the plain text form.
3094 # b) We need two forms of the prompt:
3095 # - a regexp to use in output matching,
3096 # - a value to pass to the "set prompt" command.
3097 # c) It's easier to convert the plain text form to its regexp form.
3099 # 2) Don't add a trailing space, we do that here.
3101 proc with_gdb_prompt { prompt body } {
3104 # Convert "(foo)" to "\(foo\)".
3105 # We don't use string_to_regexp because while it works today it's not
3106 # clear it will work tomorrow: the value we need must work as both a
3107 # regexp *and* as the argument to the "set prompt" command, at least until
3108 # we start recording both forms separately instead of just $gdb_prompt.
3109 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
3111 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
3113 set saved $gdb_prompt
3115 verbose -log "Setting gdb prompt to \"$prompt \"."
3116 set gdb_prompt $prompt
3117 gdb_test_no_output "set prompt $prompt " ""
3119 set code [catch {uplevel 1 $body} result]
3121 verbose -log "Restoring gdb prompt to \"$saved \"."
3122 set gdb_prompt $saved
3123 gdb_test_no_output "set prompt $saved " ""
3126 global errorInfo errorCode
3127 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3129 return -code $code $result
3133 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
3134 # BODY is finished, restore target-charset.
3136 proc with_target_charset { target_charset body } {
3140 gdb_test_multiple "show target-charset" "" {
3141 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
3142 set saved $expect_out(1,string)
3144 -re "The target character set is \"(.*)\".*$gdb_prompt " {
3145 set saved $expect_out(1,string)
3147 -re ".*$gdb_prompt " {
3148 fail "get target-charset"
3152 gdb_test_no_output -nopass "set target-charset $target_charset"
3154 set code [catch {uplevel 1 $body} result]
3156 gdb_test_no_output -nopass "set target-charset $saved"
3159 global errorInfo errorCode
3160 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3162 return -code $code $result
3166 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
3167 # mi_gdb_test etc. default to using it.
3169 proc switch_gdb_spawn_id {spawn_id} {
3171 global board board_info
3173 set gdb_spawn_id $spawn_id
3174 set board [host_info name]
3175 set board_info($board,fileid) $spawn_id
3178 # Clear the default spawn id.
3180 proc clear_gdb_spawn_id {} {
3182 global board board_info
3184 unset -nocomplain gdb_spawn_id
3185 set board [host_info name]
3186 unset -nocomplain board_info($board,fileid)
3189 # Run BODY with SPAWN_ID as current spawn id.
3191 proc with_spawn_id { spawn_id body } {
3194 if [info exists gdb_spawn_id] {
3195 set saved_spawn_id $gdb_spawn_id
3198 switch_gdb_spawn_id $spawn_id
3200 set code [catch {uplevel 1 $body} result]
3202 if [info exists saved_spawn_id] {
3203 switch_gdb_spawn_id $saved_spawn_id
3209 global errorInfo errorCode
3210 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3212 return -code $code $result
3216 # Select the largest timeout from all the timeouts:
3217 # - the local "timeout" variable of the scope two levels above,
3218 # - the global "timeout" variable,
3219 # - the board variable "gdb,timeout".
3221 proc get_largest_timeout {} {
3222 upvar #0 timeout gtimeout
3223 upvar 2 timeout timeout
3226 if [info exists timeout] {
3229 if { [info exists gtimeout] && $gtimeout > $tmt } {
3232 if { [target_info exists gdb,timeout]
3233 && [target_info gdb,timeout] > $tmt } {
3234 set tmt [target_info gdb,timeout]
3244 # Run tests in BODY with timeout increased by factor of FACTOR. When
3245 # BODY is finished, restore timeout.
3247 proc with_timeout_factor { factor body } {
3250 set savedtimeout $timeout
3252 set timeout [expr [get_largest_timeout] * $factor]
3253 set code [catch {uplevel 1 $body} result]
3255 set timeout $savedtimeout
3257 global errorInfo errorCode
3258 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3260 return -code $code $result
3264 # Run BODY with timeout factor FACTOR if check-read1 is used.
3266 proc with_read1_timeout_factor { factor body } {
3267 if { [info exists ::env(READ1)] == 1 && $::env(READ1) == 1 } {
3268 # Use timeout factor
3270 # Reset timeout factor
3273 return [uplevel [list with_timeout_factor $factor $body]]
3276 # Return 1 if _Complex types are supported, otherwise, return 0.
3278 gdb_caching_proc support_complex_tests {} {
3280 if { ![allow_float_test] } {
3281 # If floating point is not supported, _Complex is not
3286 # Compile a test program containing _Complex types.
3288 return [gdb_can_simple_compile complex {
3292 _Complex long double cld;
3298 # Return 1 if compiling go is supported.
3299 gdb_caching_proc support_go_compile {} {
3301 return [gdb_can_simple_compile go-hello {
3305 fmt.Println("hello world")
3310 # Return 1 if GDB can get a type for siginfo from the target, otherwise
3313 proc supports_get_siginfo_type {} {
3314 if { [istarget "*-*-linux*"] } {
3321 # Return 1 if memory tagging is supported at runtime, otherwise return 0.
3323 gdb_caching_proc supports_memtag {} {
3326 gdb_test_multiple "memory-tag check" "" {
3327 -re "Memory tagging not supported or disabled by the current architecture\..*$gdb_prompt $" {
3330 -re "Argument required \\(address or pointer\\).*$gdb_prompt $" {
3337 # Return 1 if the target supports hardware single stepping.
3339 proc can_hardware_single_step {} {
3341 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
3342 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
3343 || [istarget "nios2-*-*"] || [istarget "riscv*-*-linux*"] } {
3350 # Return 1 if target hardware or OS supports single stepping to signal
3351 # handler, otherwise, return 0.
3353 proc can_single_step_to_signal_handler {} {
3354 # Targets don't have hardware single step. On these targets, when
3355 # a signal is delivered during software single step, gdb is unable
3356 # to determine the next instruction addresses, because start of signal
3357 # handler is one of them.
3358 return [can_hardware_single_step]
3361 # Return 1 if target supports process record, otherwise return 0.
3363 proc supports_process_record {} {
3365 if [target_info exists gdb,use_precord] {
3366 return [target_info gdb,use_precord]
3369 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
3370 || [istarget "i\[34567\]86-*-linux*"]
3371 || [istarget "aarch64*-*-linux*"]
3372 || [istarget "powerpc*-*-linux*"]
3373 || [istarget "s390*-*-linux*"] } {
3380 # Return 1 if target supports reverse debugging, otherwise return 0.
3382 proc supports_reverse {} {
3384 if [target_info exists gdb,can_reverse] {
3385 return [target_info gdb,can_reverse]
3388 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
3389 || [istarget "i\[34567\]86-*-linux*"]
3390 || [istarget "aarch64*-*-linux*"]
3391 || [istarget "powerpc*-*-linux*"]
3392 || [istarget "s390*-*-linux*"] } {
3399 # Return 1 if readline library is used.
3401 proc readline_is_used { } {
3404 gdb_test_multiple "show editing" "" {
3405 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
3408 -re ".*$gdb_prompt $" {
3414 # Return 1 if target is ELF.
3415 gdb_caching_proc is_elf_target {} {
3416 set me "is_elf_target"
3418 set src { int foo () {return 0;} }
3419 if {![gdb_simple_compile elf_target $src]} {
3423 set fp_obj [open $obj "r"]
3424 fconfigure $fp_obj -translation binary
3425 set data [read $fp_obj]
3430 set ELFMAG "\u007FELF"
3432 if {[string compare -length 4 $data $ELFMAG] != 0} {
3433 verbose "$me: returning 0" 2
3437 verbose "$me: returning 1" 2
3441 # Return 1 if the memory at address zero is readable.
3443 gdb_caching_proc is_address_zero_readable {} {
3447 gdb_test_multiple "x 0" "" {
3448 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
3451 -re ".*$gdb_prompt $" {
3459 # Produce source file NAME and write SOURCES into it.
3461 proc gdb_produce_source { name sources } {
3463 set f [open $name "w"]
3469 # Return 1 if target is ILP32.
3470 # This cannot be decided simply from looking at the target string,
3471 # as it might depend on externally passed compiler options like -m64.
3472 gdb_caching_proc is_ilp32_target {} {
3473 return [gdb_can_simple_compile is_ilp32_target {
3474 int dummy[sizeof (int) == 4
3475 && sizeof (void *) == 4
3476 && sizeof (long) == 4 ? 1 : -1];
3480 # Return 1 if target is LP64.
3481 # This cannot be decided simply from looking at the target string,
3482 # as it might depend on externally passed compiler options like -m64.
3483 gdb_caching_proc is_lp64_target {} {
3484 return [gdb_can_simple_compile is_lp64_target {
3485 int dummy[sizeof (int) == 4
3486 && sizeof (void *) == 8
3487 && sizeof (long) == 8 ? 1 : -1];
3491 # Return 1 if target has 64 bit addresses.
3492 # This cannot be decided simply from looking at the target string,
3493 # as it might depend on externally passed compiler options like -m64.
3494 gdb_caching_proc is_64_target {} {
3495 return [gdb_can_simple_compile is_64_target {
3496 int function(void) { return 3; }
3497 int dummy[sizeof (&function) == 8 ? 1 : -1];
3501 # Return 1 if target has x86_64 registers - either amd64 or x32.
3502 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
3503 # just from the target string.
3504 gdb_caching_proc is_amd64_regs_target {} {
3505 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
3509 return [gdb_can_simple_compile is_amd64_regs_target {
3519 # Return 1 if this target is an x86 or x86-64 with -m32.
3520 proc is_x86_like_target {} {
3521 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
3524 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
3527 # Return 1 if this target is an x86_64 with -m64.
3528 proc is_x86_64_m64_target {} {
3529 return [expr [istarget x86_64-*-* ] && [is_lp64_target]]
3532 # Return 1 if this target is an arm or aarch32 on aarch64.
3534 gdb_caching_proc is_aarch32_target {} {
3535 if { [istarget "arm*-*-*"] } {
3539 if { ![istarget "aarch64*-*-*"] } {
3546 lappend list "\tmov $reg, $reg"
3549 return [gdb_can_simple_compile aarch32 [join $list \n]]
3552 # Return 1 if this target is an aarch64, either lp64 or ilp32.
3554 proc is_aarch64_target {} {
3555 if { ![istarget "aarch64*-*-*"] } {
3559 return [expr ![is_aarch32_target]]
3562 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
3563 proc support_displaced_stepping {} {
3565 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
3566 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
3567 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
3568 || [istarget "aarch64*-*-linux*"] || [istarget "loongarch*-*-linux*"] } {
3575 # Run a test on the target to see if it supports vmx hardware. Return 1 if so,
3576 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3578 gdb_caching_proc allow_altivec_tests {} {
3579 global srcdir subdir gdb_prompt inferior_exited_re
3581 set me "allow_altivec_tests"
3583 # Some simulators are known to not support VMX instructions.
3584 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
3585 verbose "$me: target known to not support VMX, returning 0" 2
3589 if {![istarget powerpc*]} {
3590 verbose "$me: PPC target required, returning 0" 2
3594 # Make sure we have a compiler that understands altivec.
3595 if [test_compiler_info gcc*] {
3596 set compile_flags "additional_flags=-maltivec"
3597 } elseif [test_compiler_info xlc*] {
3598 set compile_flags "additional_flags=-qaltivec"
3600 verbose "Could not compile with altivec support, returning 0" 2
3604 # Compile a test program containing VMX instructions.
3608 asm volatile ("vor v0,v0,v0");
3610 asm volatile ("vor 0,0,0");
3615 if {![gdb_simple_compile $me $src executable $compile_flags]} {
3619 # Compilation succeeded so now run it via gdb.
3623 gdb_reinitialize_dir $srcdir/$subdir
3627 -re ".*Illegal instruction.*${gdb_prompt} $" {
3628 verbose -log "\n$me altivec hardware not detected"
3629 set allow_vmx_tests 0
3631 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3632 verbose -log "\n$me: altivec hardware detected"
3633 set allow_vmx_tests 1
3636 warning "\n$me: default case taken"
3637 set allow_vmx_tests 0
3641 remote_file build delete $obj
3643 verbose "$me: returning $allow_vmx_tests" 2
3644 return $allow_vmx_tests
3647 # Run a test on the power target to see if it supports ISA 3.1 instructions
3648 gdb_caching_proc allow_power_isa_3_1_tests {} {
3649 global srcdir subdir gdb_prompt inferior_exited_re
3651 set me "allow_power_isa_3_1_tests"
3653 # Compile a test program containing ISA 3.1 instructions.
3656 asm volatile ("pnop"); // marker
3657 asm volatile ("nop");
3662 if {![gdb_simple_compile $me $src executable ]} {
3666 # No error message, compilation succeeded so now run it via gdb.
3670 gdb_reinitialize_dir $srcdir/$subdir
3674 -re ".*Illegal instruction.*${gdb_prompt} $" {
3675 verbose -log "\n$me Power ISA 3.1 hardware not detected"
3676 set allow_power_isa_3_1_tests 0
3678 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3679 verbose -log "\n$me: Power ISA 3.1 hardware detected"
3680 set allow_power_isa_3_1_tests 1
3683 warning "\n$me: default case taken"
3684 set allow_power_isa_3_1_tests 0
3688 remote_file build delete $obj
3690 verbose "$me: returning $allow_power_isa_3_1_tests" 2
3691 return $allow_power_isa_3_1_tests
3694 # Run a test on the target to see if it supports vmx hardware. Return 1 if so,
3695 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3697 gdb_caching_proc allow_vsx_tests {} {
3698 global srcdir subdir gdb_prompt inferior_exited_re
3700 set me "allow_vsx_tests"
3702 # Some simulators are known to not support Altivec instructions, so
3703 # they won't support VSX instructions as well.
3704 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
3705 verbose "$me: target known to not support VSX, returning 0" 2
3709 # Make sure we have a compiler that understands altivec.
3710 if [test_compiler_info gcc*] {
3711 set compile_flags "additional_flags=-mvsx"
3712 } elseif [test_compiler_info xlc*] {
3713 set compile_flags "additional_flags=-qasm=gcc"
3715 verbose "Could not compile with vsx support, returning 0" 2
3719 # Compile a test program containing VSX instructions.
3722 double a[2] = { 1.0, 2.0 };
3724 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
3726 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
3731 if {![gdb_simple_compile $me $src executable $compile_flags]} {
3735 # No error message, compilation succeeded so now run it via gdb.
3739 gdb_reinitialize_dir $srcdir/$subdir
3743 -re ".*Illegal instruction.*${gdb_prompt} $" {
3744 verbose -log "\n$me VSX hardware not detected"
3745 set allow_vsx_tests 0
3747 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3748 verbose -log "\n$me: VSX hardware detected"
3749 set allow_vsx_tests 1
3752 warning "\n$me: default case taken"
3753 set allow_vsx_tests 0
3757 remote_file build delete $obj
3759 verbose "$me: returning $allow_vsx_tests" 2
3760 return $allow_vsx_tests
3763 # Run a test on the target to see if it supports TSX hardware. Return 1 if so,
3764 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3766 gdb_caching_proc allow_tsx_tests {} {
3767 global srcdir subdir gdb_prompt inferior_exited_re
3769 set me "allow_tsx_tests"
3771 # Compile a test program.
3774 asm volatile ("xbegin .L0");
3775 asm volatile ("xend");
3776 asm volatile (".L0: nop");
3780 if {![gdb_simple_compile $me $src executable]} {
3784 # No error message, compilation succeeded so now run it via gdb.
3788 gdb_reinitialize_dir $srcdir/$subdir
3792 -re ".*Illegal instruction.*${gdb_prompt} $" {
3793 verbose -log "$me: TSX hardware not detected."
3794 set allow_tsx_tests 0
3796 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3797 verbose -log "$me: TSX hardware detected."
3798 set allow_tsx_tests 1
3801 warning "\n$me: default case taken."
3802 set allow_tsx_tests 0
3806 remote_file build delete $obj
3808 verbose "$me: returning $allow_tsx_tests" 2
3809 return $allow_tsx_tests
3812 # Run a test on the target to see if it supports avx512bf16. Return 1 if so,
3813 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3815 gdb_caching_proc allow_avx512bf16_tests {} {
3816 global srcdir subdir gdb_prompt inferior_exited_re
3818 set me "allow_avx512bf16_tests"
3819 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
3820 verbose "$me: target does not support avx512bf16, returning 0" 2
3824 # Compile a test program.
3827 asm volatile ("vcvtne2ps2bf16 %xmm0, %xmm1, %xmm0");
3831 if {![gdb_simple_compile $me $src executable]} {
3835 # No error message, compilation succeeded so now run it via gdb.
3839 gdb_reinitialize_dir $srcdir/$subdir
3843 -re ".*Illegal instruction.*${gdb_prompt} $" {
3844 verbose -log "$me: avx512bf16 hardware not detected."
3845 set allow_avx512bf16_tests 0
3847 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3848 verbose -log "$me: avx512bf16 hardware detected."
3849 set allow_avx512bf16_tests 1
3852 warning "\n$me: default case taken."
3853 set allow_avx512bf16_tests 0
3857 remote_file build delete $obj
3859 verbose "$me: returning $allow_avx512bf16_tests" 2
3860 return $allow_avx512bf16_tests
3863 # Run a test on the target to see if it supports avx512fp16. Return 1 if so,
3864 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3866 gdb_caching_proc allow_avx512fp16_tests {} {
3867 global srcdir subdir gdb_prompt inferior_exited_re
3869 set me "allow_avx512fp16_tests"
3870 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
3871 verbose "$me: target does not support avx512fp16, returning 0" 2
3875 # Compile a test program.
3878 asm volatile ("vcvtps2phx %xmm1, %xmm0");
3882 if {![gdb_simple_compile $me $src executable]} {
3886 # No error message, compilation succeeded so now run it via gdb.
3890 gdb_reinitialize_dir $srcdir/$subdir
3894 -re ".*Illegal instruction.*${gdb_prompt} $" {
3895 verbose -log "$me: avx512fp16 hardware not detected."
3896 set allow_avx512fp16_tests 0
3898 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3899 verbose -log "$me: avx512fp16 hardware detected."
3900 set allow_avx512fp16_tests 1
3903 warning "\n$me: default case taken."
3904 set allow_avx512fp16_tests 0
3908 remote_file build delete $obj
3910 verbose "$me: returning $allow_avx512fp16_tests" 2
3911 return $allow_avx512fp16_tests
3914 # Run a test on the target to see if it supports btrace hardware. Return 1 if so,
3915 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3917 gdb_caching_proc allow_btrace_tests {} {
3918 global srcdir subdir gdb_prompt inferior_exited_re
3920 set me "allow_btrace_tests"
3921 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
3922 verbose "$me: target does not support btrace, returning 0" 2
3926 # Compile a test program.
3927 set src { int main() { return 0; } }
3928 if {![gdb_simple_compile $me $src executable]} {
3932 # No error message, compilation succeeded so now run it via gdb.
3936 gdb_reinitialize_dir $srcdir/$subdir
3941 # In case of an unexpected output, we return 2 as a fail value.
3942 set allow_btrace_tests 2
3943 gdb_test_multiple "record btrace" "check btrace support" {
3944 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
3945 set allow_btrace_tests 0
3947 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
3948 set allow_btrace_tests 0
3950 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
3951 set allow_btrace_tests 0
3953 -re "^record btrace\r\n$gdb_prompt $" {
3954 set allow_btrace_tests 1
3958 remote_file build delete $obj
3960 verbose "$me: returning $allow_btrace_tests" 2
3961 return $allow_btrace_tests
3964 # Run a test on the target to see if it supports btrace pt hardware.
3965 # Return 1 if so, 0 if it does not. Based on 'check_vmx_hw_available'
3966 # from the GCC testsuite.
3968 gdb_caching_proc allow_btrace_pt_tests {} {
3969 global srcdir subdir gdb_prompt inferior_exited_re
3971 set me "allow_btrace_pt_tests"
3972 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
3973 verbose "$me: target does not support btrace, returning 1" 2
3977 # Compile a test program.
3978 set src { int main() { return 0; } }
3979 if {![gdb_simple_compile $me $src executable]} {
3983 # No error message, compilation succeeded so now run it via gdb.
3987 gdb_reinitialize_dir $srcdir/$subdir
3992 # In case of an unexpected output, we return 2 as a fail value.
3993 set allow_btrace_pt_tests 2
3994 gdb_test_multiple "record btrace pt" "check btrace pt support" {
3995 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
3996 set allow_btrace_pt_tests 0
3998 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
3999 set allow_btrace_pt_tests 0
4001 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
4002 set allow_btrace_pt_tests 0
4004 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
4005 set allow_btrace_pt_tests 0
4007 -re "^record btrace pt\r\n$gdb_prompt $" {
4008 set allow_btrace_pt_tests 1
4012 remote_file build delete $obj
4014 verbose "$me: returning $allow_btrace_pt_tests" 2
4015 return $allow_btrace_pt_tests
4018 # Run a test on the target to see if it supports Aarch64 SVE hardware.
4019 # Return 1 if so, 0 if it does not. Note this causes a restart of GDB.
4021 gdb_caching_proc allow_aarch64_sve_tests {} {
4022 global srcdir subdir gdb_prompt inferior_exited_re
4024 set me "allow_aarch64_sve_tests"
4026 if { ![is_aarch64_target]} {
4030 set compile_flags "{additional_flags=-march=armv8-a+sve}"
4032 # Compile a test program containing SVE instructions.
4035 asm volatile ("ptrue p0.b");
4039 if {![gdb_simple_compile $me $src executable $compile_flags]} {
4043 # Compilation succeeded so now run it via gdb.
4047 -re ".*Illegal instruction.*${gdb_prompt} $" {
4048 verbose -log "\n$me sve hardware not detected"
4049 set allow_sve_tests 0
4051 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
4052 verbose -log "\n$me: sve hardware detected"
4053 set allow_sve_tests 1
4056 warning "\n$me: default case taken"
4057 set allow_sve_tests 0
4061 remote_file build delete $obj
4063 verbose "$me: returning $allow_sve_tests" 2
4064 return $allow_sve_tests
4068 # A helper that compiles a test case to see if __int128 is supported.
4069 proc gdb_int128_helper {lang} {
4070 return [gdb_can_simple_compile "i128-for-$lang" {
4072 int main() { return 0; }
4076 # Return true if the C compiler understands the __int128 type.
4077 gdb_caching_proc has_int128_c {} {
4078 return [gdb_int128_helper c]
4081 # Return true if the C++ compiler understands the __int128 type.
4082 gdb_caching_proc has_int128_cxx {} {
4083 return [gdb_int128_helper c++]
4086 # Return true if the IFUNC feature is supported.
4087 gdb_caching_proc allow_ifunc_tests {} {
4088 if [gdb_can_simple_compile ifunc {
4090 typedef void F (void);
4091 F* g (void) { return &f_; }
4092 void f () __attribute__ ((ifunc ("g")));
4100 # Return whether we should skip tests for showing inlined functions in
4101 # backtraces. Requires get_compiler_info and get_debug_format.
4103 proc skip_inline_frame_tests {} {
4104 # GDB only recognizes inlining information in DWARF.
4105 if { ! [test_debug_format "DWARF \[0-9\]"] } {
4109 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
4110 if { ([test_compiler_info "gcc-2-*"]
4111 || [test_compiler_info "gcc-3-*"]
4112 || [test_compiler_info "gcc-4-0-*"]) } {
4119 # Return whether we should skip tests for showing variables from
4120 # inlined functions. Requires get_compiler_info and get_debug_format.
4122 proc skip_inline_var_tests {} {
4123 # GDB only recognizes inlining information in DWARF.
4124 if { ! [test_debug_format "DWARF \[0-9\]"] } {
4131 # Return a 1 if we should run tests that require hardware breakpoints
4133 proc allow_hw_breakpoint_tests {} {
4134 # Skip tests if requested by the board (note that no_hardware_watchpoints
4135 # disables both watchpoints and breakpoints)
4136 if { [target_info exists gdb,no_hardware_watchpoints]} {
4140 # These targets support hardware breakpoints natively
4141 if { [istarget "i?86-*-*"]
4142 || [istarget "x86_64-*-*"]
4143 || [istarget "ia64-*-*"]
4144 || [istarget "arm*-*-*"]
4145 || [istarget "aarch64*-*-*"]
4146 || [istarget "s390*-*-*"] } {
4153 # Return a 1 if we should run tests that require hardware watchpoints
4155 proc allow_hw_watchpoint_tests {} {
4156 # Skip tests if requested by the board
4157 if { [target_info exists gdb,no_hardware_watchpoints]} {
4161 # These targets support hardware watchpoints natively
4162 # Note, not all Power 9 processors support hardware watchpoints due to a HW
4163 # bug. Use has_hw_wp_support to check do a runtime check for hardware
4164 # watchpoint support on Powerpc.
4165 if { [istarget "i?86-*-*"]
4166 || [istarget "x86_64-*-*"]
4167 || [istarget "ia64-*-*"]
4168 || [istarget "arm*-*-*"]
4169 || [istarget "aarch64*-*-*"]
4170 || ([istarget "powerpc*-*-linux*"] && [has_hw_wp_support])
4171 || [istarget "s390*-*-*"] } {
4178 # Return a 1 if we should run tests that require *multiple* hardware
4179 # watchpoints to be active at the same time
4181 proc allow_hw_watchpoint_multi_tests {} {
4182 if { ![allow_hw_watchpoint_tests] } {
4186 # These targets support just a single hardware watchpoint
4187 if { [istarget "arm*-*-*"]
4188 || [istarget "powerpc*-*-linux*"] } {
4195 # Return a 1 if we should run tests that require read/access watchpoints
4197 proc allow_hw_watchpoint_access_tests {} {
4198 if { ![allow_hw_watchpoint_tests] } {
4202 # These targets support just write watchpoints
4203 if { [istarget "s390*-*-*"] } {
4210 # Return 1 if we should skip tests that require the runtime unwinder
4211 # hook. This must be invoked while gdb is running, after shared
4212 # libraries have been loaded. This is needed because otherwise a
4213 # shared libgcc won't be visible.
4215 proc skip_unwinder_tests {} {
4219 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
4220 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
4222 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
4225 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
4229 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
4230 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
4233 -re "\r\n$gdb_prompt $" {
4240 # Return 1 if we should skip tests that require the libstdc++ stap
4241 # probes. This must be invoked while gdb is running, after shared
4242 # libraries have been loaded. PROMPT_REGEXP is the expected prompt.
4244 proc skip_libstdcxx_probe_tests_prompt { prompt_regexp } {
4246 gdb_test_multiple "info probe" "check for stap probe in libstdc++" \
4247 -prompt "$prompt_regexp" {
4248 -re ".*libstdcxx.*catch.*\r\n$prompt_regexp" {
4251 -re "\r\n$prompt_regexp" {
4254 set skip [expr !$supported]
4258 # As skip_libstdcxx_probe_tests_prompt, with gdb_prompt.
4260 proc skip_libstdcxx_probe_tests {} {
4262 return [skip_libstdcxx_probe_tests_prompt "$gdb_prompt $"]
4265 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
4266 # we're looking for (used to build the test name). TARGET_STACK_REGEXP
4267 # is a regexp that will match the output of "maint print target-stack" if
4268 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
4269 # matching the expected prompt after the command output.
4271 # NOTE: GDB must be running BEFORE this procedure is called!
4273 proc gdb_is_target_1 { target_name target_stack_regexp prompt_regexp } {
4276 # Throw a Tcl error if gdb isn't already started.
4277 if {![info exists gdb_spawn_id]} {
4278 error "gdb_is_target_1 called with no running gdb instance"
4281 set test "probe for target ${target_name}"
4282 gdb_test_multiple "maint print target-stack" $test \
4283 -prompt "$prompt_regexp" {
4284 -re "${target_stack_regexp}${prompt_regexp}" {
4288 -re "$prompt_regexp" {
4295 # Helper for gdb_is_target_remote where the expected prompt is variable.
4297 # NOTE: GDB must be running BEFORE this procedure is called!
4299 proc gdb_is_target_remote_prompt { prompt_regexp } {
4300 return [gdb_is_target_1 "remote" ".*emote target using gdb-specific protocol.*" $prompt_regexp]
4303 # Check whether we're testing with the remote or extended-remote
4306 # NOTE: GDB must be running BEFORE this procedure is called!
4308 proc gdb_is_target_remote { } {
4311 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
4314 # Check whether we're testing with the native target.
4316 # NOTE: GDB must be running BEFORE this procedure is called!
4318 proc gdb_is_target_native { } {
4321 return [gdb_is_target_1 "native" ".*native \\(Native process\\).*" "$gdb_prompt $"]
4324 # Like istarget, but checks a list of targets.
4325 proc is_any_target {args} {
4326 foreach targ $args {
4327 if {[istarget $targ]} {
4334 # Return the effective value of use_gdb_stub.
4336 # If the use_gdb_stub global has been set (it is set when the gdb process is
4337 # spawned), return that. Otherwise, return the value of the use_gdb_stub
4338 # property from the board file.
4340 # This is the preferred way of checking use_gdb_stub, since it allows to check
4341 # the value before the gdb has been spawned and it will return the correct value
4342 # even when it was overriden by the test.
4344 # Note that stub targets are not able to spawn new inferiors. Use this
4345 # check for skipping respective tests.
4347 proc use_gdb_stub {} {
4350 if [info exists use_gdb_stub] {
4351 return $use_gdb_stub
4354 return [target_info exists use_gdb_stub]
4357 # Return 1 if the current remote target is an instance of our GDBserver, 0
4358 # otherwise. Return -1 if there was an error and we can't tell.
4360 gdb_caching_proc target_is_gdbserver {} {
4364 set test "probing for GDBserver"
4366 gdb_test_multiple "monitor help" $test {
4367 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
4370 -re "$gdb_prompt $" {
4375 if { $is_gdbserver == -1 } {
4376 verbose -log "Unable to tell whether we are using GDBserver or not."
4379 return $is_gdbserver
4382 # N.B. compiler_info is intended to be local to this file.
4383 # Call test_compiler_info with no arguments to fetch its value.
4384 # Yes, this is counterintuitive when there's get_compiler_info,
4385 # but that's the current API.
4386 if [info exists compiler_info] {
4390 # Figure out what compiler I am using.
4391 # The result is cached so only the first invocation runs the compiler.
4393 # ARG can be empty or "C++". If empty, "C" is assumed.
4395 # There are several ways to do this, with various problems.
4397 # [ gdb_compile -E $ifile -o $binfile.ci ]
4398 # source $binfile.ci
4400 # Single Unix Spec v3 says that "-E -o ..." together are not
4401 # specified. And in fact, the native compiler on hp-ux 11 (among
4402 # others) does not work with "-E -o ...". Most targets used to do
4403 # this, and it mostly worked, because it works with gcc.
4405 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
4406 # source $binfile.ci
4408 # This avoids the problem with -E and -o together. This almost works
4409 # if the build machine is the same as the host machine, which is
4410 # usually true of the targets which are not gcc. But this code does
4411 # not figure which compiler to call, and it always ends up using the C
4412 # compiler. Not good for setting hp_aCC_compiler. Target
4413 # hppa*-*-hpux* used to do this.
4415 # [ gdb_compile -E $ifile > $binfile.ci ]
4416 # source $binfile.ci
4418 # dejagnu target_compile says that it supports output redirection,
4419 # but the code is completely different from the normal path and I
4420 # don't want to sweep the mines from that path. So I didn't even try
4423 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
4426 # I actually do this for all targets now. gdb_compile runs the right
4427 # compiler, and TCL captures the output, and I eval the output.
4429 # Unfortunately, expect logs the output of the command as it goes by,
4430 # and dejagnu helpfully prints a second copy of it right afterwards.
4431 # So I turn off expect logging for a moment.
4433 # [ gdb_compile $ifile $ciexe_file executable $args ]
4434 # [ remote_exec $ciexe_file ]
4435 # [ source $ci_file.out ]
4437 # I could give up on -E and just do this.
4438 # I didn't get desperate enough to try this.
4440 # -- chastain 2004-01-06
4442 proc get_compiler_info {{language "c"}} {
4444 # For compiler.c, compiler.cc and compiler.F90.
4447 # I am going to play with the log to keep noise out.
4451 # These come from compiler.c, compiler.cc or compiler.F90.
4452 gdb_persistent_global compiler_info_cache
4454 if [info exists compiler_info_cache($language)] {
4459 # Choose which file to preprocess.
4460 if { $language == "c++" } {
4461 set ifile "${srcdir}/lib/compiler.cc"
4462 } elseif { $language == "f90" } {
4463 set ifile "${srcdir}/lib/compiler.F90"
4464 } elseif { $language == "c" } {
4465 set ifile "${srcdir}/lib/compiler.c"
4467 perror "Unable to fetch compiler version for language: $language"
4471 # Run $ifile through the right preprocessor.
4472 # Toggle gdb.log to keep the compiler output out of the log.
4473 set saved_log [log_file -info]
4475 if [is_remote host] {
4476 # We have to use -E and -o together, despite the comments
4477 # above, because of how DejaGnu handles remote host testing.
4478 set ppout "$outdir/compiler.i"
4479 gdb_compile "${ifile}" "$ppout" preprocess [list "$language" quiet getting_compiler_info]
4480 set file [open $ppout r]
4481 set cppout [read $file]
4484 # Copy $ifile to temp dir, to work around PR gcc/60447. This will leave the
4485 # superfluous .s file in the temp dir instead of in the source dir.
4486 set tofile [file tail $ifile]
4487 set tofile [standard_temp_file $tofile]
4488 file copy -force $ifile $tofile
4490 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$language" quiet getting_compiler_info] ]
4492 eval log_file $saved_log
4496 foreach cppline [ split "$cppout" "\n" ] {
4497 if { [ regexp "^#" "$cppline" ] } {
4499 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
4501 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
4503 verbose "get_compiler_info: $cppline" 2
4505 } elseif { [ regexp "flang.*warning.*'-fdiagnostics-color=never'" "$cppline"] } {
4506 # Both flang preprocessors (llvm flang and classic flang) print a
4507 # warning for the unused -fdiagnostics-color=never, so we skip this
4511 verbose -log "get_compiler_info: $cppline"
4516 # Set to unknown if for some reason compiler_info didn't get defined.
4517 if ![info exists compiler_info] {
4518 verbose -log "get_compiler_info: compiler_info not provided"
4519 set compiler_info "unknown"
4521 # Also set to unknown compiler if any diagnostics happened.
4523 verbose -log "get_compiler_info: got unexpected diagnostics"
4524 set compiler_info "unknown"
4527 set compiler_info_cache($language) $compiler_info
4529 # Log what happened.
4530 verbose -log "get_compiler_info: $compiler_info"
4535 # Return the compiler_info string if no arg is provided.
4536 # Otherwise the argument is a glob-style expression to match against
4539 proc test_compiler_info { {compiler ""} {language "c"} } {
4540 gdb_persistent_global compiler_info_cache
4542 if [get_compiler_info $language] {
4543 # An error will already have been printed in this case. Just
4544 # return a suitable result depending on how the user called
4546 if [string match "" $compiler] {
4553 # If no arg, return the compiler_info string.
4554 if [string match "" $compiler] {
4555 return $compiler_info_cache($language)
4558 return [string match $compiler $compiler_info_cache($language)]
4561 # Return true if the C compiler is GCC, otherwise, return false.
4563 proc is_c_compiler_gcc {} {
4564 set compiler_info [test_compiler_info]
4565 set gcc_compiled false
4566 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
4567 return $gcc_compiled
4570 # Return the gcc major version, or -1.
4571 # For gcc 4.8.5, the major version is 4.8.
4572 # For gcc 7.5.0, the major version 7.
4573 # The COMPILER and LANGUAGE arguments are as for test_compiler_info.
4575 proc gcc_major_version { {compiler "gcc-*"} {language "c"} } {
4577 if { ![test_compiler_info $compiler $language] } {
4580 # Strip "gcc-*" to "gcc".
4581 regsub -- {-.*} $compiler "" compiler
4582 set res [regexp $compiler-($decimal)-($decimal)- \
4583 [test_compiler_info "" $language] \
4584 dummy_var major minor]
4591 return $major.$minor
4594 proc current_target_name { } {
4596 if [info exists target_info(target,name)] {
4597 set answer $target_info(target,name)
4604 set gdb_wrapper_initialized 0
4605 set gdb_wrapper_target ""
4606 set gdb_wrapper_file ""
4607 set gdb_wrapper_flags ""
4609 proc gdb_wrapper_init { args } {
4610 global gdb_wrapper_initialized
4611 global gdb_wrapper_file
4612 global gdb_wrapper_flags
4613 global gdb_wrapper_target
4615 if { $gdb_wrapper_initialized == 1 } { return; }
4617 if {[target_info exists needs_status_wrapper] && \
4618 [target_info needs_status_wrapper] != "0"} {
4619 set result [build_wrapper "testglue.o"]
4620 if { $result != "" } {
4621 set gdb_wrapper_file [lindex $result 0]
4622 if ![is_remote host] {
4623 set gdb_wrapper_file [file join [pwd] $gdb_wrapper_file]
4625 set gdb_wrapper_flags [lindex $result 1]
4627 warning "Status wrapper failed to build."
4630 set gdb_wrapper_file ""
4631 set gdb_wrapper_flags ""
4633 verbose "set gdb_wrapper_file = $gdb_wrapper_file"
4634 set gdb_wrapper_initialized 1
4635 set gdb_wrapper_target [current_target_name]
4638 # Determine options that we always want to pass to the compiler.
4639 gdb_caching_proc universal_compile_options {} {
4640 set me "universal_compile_options"
4643 set src [standard_temp_file ccopts.c]
4644 set obj [standard_temp_file ccopts.o]
4646 gdb_produce_source $src {
4647 int foo(void) { return 0; }
4650 # Try an option for disabling colored diagnostics. Some compilers
4651 # yield colored diagnostics by default (when run from a tty) unless
4652 # such an option is specified.
4653 set opt "additional_flags=-fdiagnostics-color=never"
4654 set lines [target_compile $src $obj object [list "quiet" $opt]]
4655 if {[string match "" $lines]} {
4656 # Seems to have worked; use the option.
4657 lappend options $opt
4662 verbose "$me: returning $options" 2
4666 # Compile the code in $code to a file based on $name, using the flags
4667 # $compile_flag as well as debug, nowarning and quiet (unless otherwise
4668 # specified in default_compile_flags).
4669 # Return 1 if code can be compiled
4670 # Leave the file name of the resulting object in the upvar object.
4672 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj} {default_compile_flags {}}} {
4675 switch -regexp -- $type {
4690 foreach flag $compile_flags {
4691 if { "$flag" == "go" } {
4695 if { "$flag" eq "hip" } {
4699 if { "$flag" eq "d" } {
4704 set src [standard_temp_file $name.$ext]
4705 set obj [standard_temp_file $name.$postfix]
4706 if { $default_compile_flags == "" } {
4707 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
4709 set compile_flags [concat $compile_flags $default_compile_flags]
4712 gdb_produce_source $src $code
4714 verbose "$name: compiling testfile $src" 2
4715 set lines [gdb_compile $src $obj $type $compile_flags]
4719 if {![string match "" $lines]} {
4720 verbose "$name: compilation failed, returning 0" 2
4726 # Compile the code in $code to a file based on $name, using the flags
4727 # $compile_flag as well as debug, nowarning and quiet (unless otherwise
4728 # specified in default_compile_flags).
4729 # Return 1 if code can be compiled
4730 # Delete all created files and objects.
4732 proc gdb_can_simple_compile {name code {type object} {compile_flags ""} {default_compile_flags ""}} {
4733 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj \
4734 $default_compile_flags]
4735 file delete $temp_obj
4739 # Some targets need to always link a special object in. Save its path here.
4740 global gdb_saved_set_unbuffered_mode_obj
4741 set gdb_saved_set_unbuffered_mode_obj ""
4743 # Escape STR sufficiently for use on host commandline.
4745 proc escape_for_host { str } {
4746 if { [is_remote host] } {
4756 return [string map $map $str]
4759 # Add double quotes around ARGS, sufficiently escaped for use on host
4762 proc quote_for_host { args } {
4763 set str [join $args]
4764 if { [is_remote host] } {
4765 set str [join [list {\"} $str {\"}] ""]
4767 set str [join [list {"} $str {"}] ""]
4772 # Compile source files specified by SOURCE into a binary of type TYPE at path
4773 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
4774 # parameter and most options are passed directly to it.
4776 # The type can be one of the following:
4778 # - object: Compile into an object file.
4779 # - executable: Compile and link into an executable.
4780 # - preprocess: Preprocess the source files.
4781 # - assembly: Generate assembly listing.
4783 # The following options are understood and processed by gdb_compile:
4785 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
4786 # quirks to be able to use shared libraries.
4787 # - shlib_load: Link with appropriate libraries to allow the test to
4788 # dynamically load libraries at runtime. For example, on Linux, this adds
4789 # -ldl so that the test can use dlopen.
4790 # - nowarnings: Inhibit all compiler warnings.
4791 # - pie: Force creation of PIE executables.
4792 # - nopie: Prevent creation of PIE executables.
4793 # - macros: Add the required compiler flag to include macro information in
4795 # - text_segment=addr: Tell the linker to place the text segment at ADDR.
4796 # - build-id: Ensure the final binary includes a build-id.
4798 # And here are some of the not too obscure options understood by DejaGnu that
4799 # influence the compilation:
4801 # - additional_flags=flag: Add FLAG to the compiler flags.
4802 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
4803 # argument can be a file, in which case it's added to the sources, or a
4805 # - ldflags=flag: Add FLAG to the linker flags.
4806 # - incdir=path: Add PATH to the searched include directories.
4807 # - libdir=path: Add PATH to the linker searched directories.
4808 # - ada, c++, f90, go, rust: Compile the file as Ada, C++,
4809 # Fortran 90, Go or Rust.
4810 # - debug: Build with debug information.
4811 # - optimize: Build with optimization.
4813 proc gdb_compile {source dest type options} {
4814 global GDB_TESTCASE_OPTIONS
4815 global gdb_wrapper_file
4816 global gdb_wrapper_flags
4819 global gdb_saved_set_unbuffered_mode_obj
4821 set outdir [file dirname $dest]
4823 # If this is set, calling test_compiler_info will cause recursion.
4824 if { [lsearch -exact $options getting_compiler_info] == -1 } {
4825 set getting_compiler_info false
4827 set getting_compiler_info true
4830 # Add platform-specific options if a shared library was specified using
4831 # "shlib=librarypath" in OPTIONS.
4833 if {[lsearch -exact $options rust] != -1} {
4834 # -fdiagnostics-color is not a rustcc option.
4836 set new_options [universal_compile_options]
4839 # C/C++ specific settings.
4840 if {!$getting_compiler_info
4841 && [lsearch -exact $options rust] == -1
4842 && [lsearch -exact $options ada] == -1
4843 && [lsearch -exact $options f90] == -1
4844 && [lsearch -exact $options go] == -1} {
4846 # Some C/C++ testcases unconditionally pass -Wno-foo as additional
4847 # options to disable some warning. That is OK with GCC, because
4848 # by design, GCC accepts any -Wno-foo option, even if it doesn't
4849 # support -Wfoo. Clang however warns about unknown -Wno-foo by
4850 # default, unless you pass -Wno-unknown-warning-option as well.
4851 # We do that here, so that individual testcases don't have to
4853 if {[test_compiler_info "clang-*"] || [test_compiler_info "icx-*"]} {
4854 lappend new_options "additional_flags=-Wno-unknown-warning-option"
4855 } elseif {[test_compiler_info "icc-*"]} {
4856 # This is the equivalent for the icc compiler.
4857 lappend new_options "additional_flags=-diag-disable=10148"
4860 # icpx/icx give the following warning if '-g' is used without '-O'.
4862 # icpx: remark: Note that use of '-g' without any
4863 # optimization-level option will turn off most compiler
4864 # optimizations similar to use of '-O0'
4866 # The warning makes dejagnu think that compilation has failed.
4868 # Furthermore, if no -O flag is passed, icx and icc optimize
4869 # the code by default. This breaks assumptions in many GDB
4870 # tests that the code is unoptimized by default.
4872 # To fix both problems, pass the -O0 flag explicitly, if no
4873 # optimization option is given.
4874 if {[test_compiler_info "icx-*"] || [test_compiler_info "icc-*"]} {
4875 if {[lsearch $options optimize=*] == -1
4876 && [lsearch $options additional_flags=-O*] == -1} {
4877 lappend new_options "optimize=-O0"
4881 # Starting with 2021.7.0 (recognized as icc-20-21-7 by GDB) icc and
4882 # icpc are marked as deprecated and both compilers emit the remark
4883 # #10441. To let GDB still compile successfully, we disable these
4885 if {([lsearch -exact $options c++] != -1
4886 && [test_compiler_info {icc-20-21-[7-9]} c++])
4887 || [test_compiler_info {icc-20-21-[7-9]}]} {
4888 lappend new_options "additional_flags=-diag-disable=10441"
4892 # If the 'build-id' option is used, then ensure that we generate a
4893 # build-id. GCC does this by default, but Clang does not, so
4895 if {[lsearch -exact $options build-id] > 0
4896 && [test_compiler_info "clang-*"]} {
4897 lappend new_options "additional_flags=-Wl,--build-id"
4900 # Treating .c input files as C++ is deprecated in Clang, so
4901 # explicitly force C++ language.
4902 if { !$getting_compiler_info
4903 && [lsearch -exact $options c++] != -1
4904 && [string match *.c $source] != 0 } {
4906 # gdb_compile cannot handle this combination of options, the
4907 # result is a command like "clang -x c++ foo.c bar.so -o baz"
4908 # which tells Clang to treat bar.so as C++. The solution is
4909 # to call gdb_compile twice--once to compile, once to link--
4910 # either directly, or via build_executable_from_specs.
4911 if { [lsearch $options shlib=*] != -1 } {
4912 error "incompatible gdb_compile options"
4915 if {[test_compiler_info "clang-*"]} {
4916 lappend new_options early_flags=-x\ c++
4920 # Place (and look for) Fortran `.mod` files in the output
4921 # directory for this specific test. For Intel compilers the -J
4922 # option is not supported so instead use the -module flag.
4923 # Additionally, Intel compilers need the -debug-parameters flag set to
4924 # emit debug info for all parameters in modules.
4926 # ifx gives the following warning if '-g' is used without '-O'.
4928 # ifx: remark #10440: Note that use of a debug option
4929 # without any optimization-level option will turnoff most
4930 # compiler optimizations similar to use of '-O0'
4932 # The warning makes dejagnu think that compilation has failed.
4934 # Furthermore, if no -O flag is passed, Intel compilers optimize
4935 # the code by default. This breaks assumptions in many GDB
4936 # tests that the code is unoptimized by default.
4938 # To fix both problems, pass the -O0 flag explicitly, if no
4939 # optimization option is given.
4940 if { !$getting_compiler_info && [lsearch -exact $options f90] != -1 } {
4942 set mod_path [standard_output_file ""]
4943 if { [test_compiler_info {gfortran-*} f90] } {
4944 lappend new_options "additional_flags=-J${mod_path}"
4945 } elseif { [test_compiler_info {ifort-*} f90]
4946 || [test_compiler_info {ifx-*} f90] } {
4947 lappend new_options "additional_flags=-module ${mod_path}"
4948 lappend new_options "additional_flags=-debug-parameters all"
4950 if {[lsearch $options optimize=*] == -1
4951 && [lsearch $options additional_flags=-O*] == -1} {
4952 lappend new_options "optimize=-O0"
4959 foreach opt $options {
4960 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
4961 && $type == "executable"} {
4962 if [test_compiler_info "xlc-*"] {
4963 # IBM xlc compiler doesn't accept shared library named other
4964 # than .so: use "-Wl," to bypass this
4965 lappend source "-Wl,$shlib_name"
4966 } elseif { ([istarget "*-*-mingw*"]
4967 || [istarget *-*-cygwin*]
4968 || [istarget *-*-pe*])} {
4969 lappend source "${shlib_name}.a"
4971 lappend source $shlib_name
4973 if { $shlib_found == 0 } {
4975 if { ([istarget "*-*-mingw*"]
4976 || [istarget *-*-cygwin*]) } {
4977 lappend new_options "ldflags=-Wl,--enable-auto-import"
4979 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
4980 # Undo debian's change in the default.
4981 # Put it at the front to not override any user-provided
4982 # value, and to make sure it appears in front of all the
4984 lappend new_options "early_flags=-Wl,--no-as-needed"
4987 } elseif { $opt == "shlib_load" && $type == "executable" } {
4989 } elseif { $opt == "getting_compiler_info" } {
4990 # Ignore this setting here as it has been handled earlier in this
4991 # procedure. Do not append it to new_options as this will cause
4993 } elseif {[regexp "^text_segment=(.*)" $opt dummy_var addr]} {
4994 if { [linker_supports_Ttext_segment_flag] } {
4996 lappend new_options "ldflags=-Wl,-Ttext-segment=$addr"
4997 } elseif { [linker_supports_image_base_flag] } {
4999 lappend new_options "ldflags=-Wl,--image-base=$addr"
5000 } elseif { [linker_supports_Ttext_flag] } {
5001 # For old GNU gold versions.
5002 lappend new_options "ldflags=-Wl,-Ttext=$addr"
5004 error "Don't know how to handle text_segment option."
5007 lappend new_options $opt
5011 # Ensure stack protector is disabled for GCC, as this causes problems with
5012 # DWARF line numbering.
5013 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
5014 # This option defaults to on for Debian/Ubuntu.
5015 if { !$getting_compiler_info
5016 && [test_compiler_info {gcc-*-*}]
5017 && !([test_compiler_info {gcc-[0-3]-*}]
5018 || [test_compiler_info {gcc-4-0-*}])
5019 && [lsearch -exact $options rust] == -1} {
5020 # Put it at the front to not override any user-provided value.
5021 lappend new_options "early_flags=-fno-stack-protector"
5024 # hipcc defaults to -O2, so add -O0 to early flags for the hip language.
5025 # If "optimize" is also requested, another -O flag (e.g. -O2) will be added
5026 # to the flags, overriding this -O0.
5027 if {[lsearch -exact $options hip] != -1} {
5028 lappend new_options "early_flags=-O0"
5031 # Because we link with libraries using their basename, we may need
5032 # (depending on the platform) to set a special rpath value, to allow
5033 # the executable to find the libraries it depends on.
5034 if { $shlib_load || $shlib_found } {
5035 if { ([istarget "*-*-mingw*"]
5036 || [istarget *-*-cygwin*]
5037 || [istarget *-*-pe*]) } {
5038 # Do not need anything.
5039 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
5040 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
5042 if { $shlib_load } {
5043 lappend new_options "libs=-ldl"
5045 lappend new_options [escape_for_host {ldflags=-Wl,-rpath,$ORIGIN}]
5048 set options $new_options
5050 if [info exists GDB_TESTCASE_OPTIONS] {
5051 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
5053 verbose "options are $options"
5054 verbose "source is $source $dest $type $options"
5058 if {[target_info exists needs_status_wrapper] && \
5059 [target_info needs_status_wrapper] != "0" && \
5060 $gdb_wrapper_file != "" } {
5061 lappend options "libs=${gdb_wrapper_file}"
5062 lappend options "ldflags=${gdb_wrapper_flags}"
5065 # Replace the "nowarnings" option with the appropriate additional_flags
5066 # to disable compiler warnings.
5067 set nowarnings [lsearch -exact $options nowarnings]
5068 if {$nowarnings != -1} {
5069 if [target_info exists gdb,nowarnings_flag] {
5070 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
5072 set flag "additional_flags=-w"
5074 set options [lreplace $options $nowarnings $nowarnings $flag]
5077 # Replace the "pie" option with the appropriate compiler and linker flags
5078 # to enable PIE executables.
5079 set pie [lsearch -exact $options pie]
5081 if [target_info exists gdb,pie_flag] {
5082 set flag "additional_flags=[target_info gdb,pie_flag]"
5084 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
5085 # and SPARC, fpie can cause compile errors due to the GOT exceeding
5086 # a maximum size. On other architectures the two flags are
5087 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
5088 # onwards default GCC to using fPIE. If you do require fpie, then
5089 # it can be set using the pie_flag.
5090 set flag "additional_flags=-fPIE"
5092 set options [lreplace $options $pie $pie $flag]
5094 if [target_info exists gdb,pie_ldflag] {
5095 set flag "ldflags=[target_info gdb,pie_ldflag]"
5097 set flag "ldflags=-pie"
5099 lappend options "$flag"
5102 # Replace the "nopie" option with the appropriate compiler and linker
5103 # flags to disable PIE executables.
5104 set nopie [lsearch -exact $options nopie]
5106 if [target_info exists gdb,nopie_flag] {
5107 set flag "additional_flags=[target_info gdb,nopie_flag]"
5109 set flag "additional_flags=-fno-pie"
5111 set options [lreplace $options $nopie $nopie $flag]
5113 if [target_info exists gdb,nopie_ldflag] {
5114 set flag "ldflags=[target_info gdb,nopie_ldflag]"
5116 set flag "ldflags=-no-pie"
5118 lappend options "$flag"
5121 set macros [lsearch -exact $options macros]
5122 if {$macros != -1} {
5123 if { [test_compiler_info "clang-*"] } {
5124 set flag "additional_flags=-fdebug-macro"
5126 set flag "additional_flags=-g3"
5129 set options [lreplace $options $macros $macros $flag]
5132 if { $type == "executable" } {
5133 if { ([istarget "*-*-mingw*"]
5134 || [istarget "*-*-*djgpp"]
5135 || [istarget "*-*-cygwin*"])} {
5136 # Force output to unbuffered mode, by linking in an object file
5137 # with a global contructor that calls setvbuf.
5139 # Compile the special object separately for two reasons:
5140 # 1) Insulate it from $options.
5141 # 2) Avoid compiling it for every gdb_compile invocation,
5142 # which is time consuming, especially if we're remote
5145 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
5146 verbose "compiling gdb_saved_set_unbuffered_obj"
5147 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
5148 set unbuf_obj ${objdir}/set_unbuffered_mode.o
5150 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
5151 if { $result != "" } {
5154 if {[is_remote host]} {
5155 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
5157 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
5159 # Link a copy of the output object, because the
5160 # original may be automatically deleted.
5161 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
5163 verbose "gdb_saved_set_unbuffered_obj already compiled"
5166 # Rely on the internal knowledge that the global ctors are ran in
5167 # reverse link order. In that case, we can use ldflags to
5168 # avoid copying the object file to the host multiple
5170 # This object can only be added if standard libraries are
5171 # used. Thus, we need to disable it if -nostdlib option is used
5172 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
5173 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
5178 cond_wrap [expr $pie != -1 || $nopie != -1] \
5179 with_PIE_multilib_flags_filtered {
5180 set result [target_compile $source $dest $type $options]
5183 # Prune uninteresting compiler (and linker) output.
5184 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
5186 # Starting with 2021.7.0 icc and icpc are marked as deprecated and both
5187 # compilers emit a remark #10441. To let GDB still compile successfully,
5188 # we disable these warnings. When $getting_compiler_info is true however,
5189 # we do not yet know the compiler (nor its version) and instead prune these
5190 # lines from the compiler output to let the get_compiler_info pass.
5191 if {$getting_compiler_info} {
5193 "(icc|icpc): remark #10441: The Intel\\(R\\) C\\+\\+ Compiler Classic \\(ICC\\) is deprecated\[^\r\n\]*" \
5197 regsub "\[\r\n\]*$" "$result" "" result
5198 regsub "^\[\r\n\]*" "$result" "" result
5200 if { $type == "executable" && $result == "" \
5201 && ($nopie != -1 || $pie != -1) } {
5202 set is_pie [exec_is_pie "$dest"]
5203 if { $nopie != -1 && $is_pie == 1 } {
5204 set result "nopie failed to prevent PIE executable"
5205 } elseif { $pie != -1 && $is_pie == 0 } {
5206 set result "pie failed to generate PIE executable"
5210 if {[lsearch $options quiet] < 0} {
5211 if { $result != "" } {
5212 clone_output "gdb compile failed, $result"
5219 # This is just like gdb_compile, above, except that it tries compiling
5220 # against several different thread libraries, to see which one this
5222 proc gdb_compile_pthreads {source dest type options} {
5223 if {$type != "executable"} {
5224 return [gdb_compile $source $dest $type $options]
5227 set why_msg "unrecognized error"
5228 foreach lib {-lpthreads -lpthread -lthread ""} {
5229 # This kind of wipes out whatever libs the caller may have
5230 # set. Or maybe theirs will override ours. How infelicitous.
5231 set options_with_lib [concat $options [list libs=$lib quiet]]
5232 set ccout [gdb_compile $source $dest $type $options_with_lib]
5233 switch -regexp -- $ccout {
5234 ".*no posix threads support.*" {
5235 set why_msg "missing threads include file"
5238 ".*cannot open -lpthread.*" {
5239 set why_msg "missing runtime threads library"
5241 ".*Can't find library for -lpthread.*" {
5242 set why_msg "missing runtime threads library"
5245 pass "successfully compiled posix threads test case"
5251 if {!$built_binfile} {
5252 unsupported "couldn't compile [file tail $source]: ${why_msg}"
5257 # Build a shared library from SOURCES.
5259 proc gdb_compile_shlib_1 {sources dest options} {
5260 set obj_options $options
5263 if { [lsearch -exact $options "ada"] >= 0 } {
5267 if { [lsearch -exact $options "c++"] >= 0 } {
5268 set info_options "c++"
5269 } elseif { [lsearch -exact $options "f90"] >= 0 } {
5270 set info_options "f90"
5272 set info_options "c"
5275 switch -glob [test_compiler_info "" ${info_options}] {
5277 lappend obj_options "additional_flags=-qpic"
5280 if { [istarget "*-*-cygwin*"]
5281 || [istarget "*-*-mingw*"] } {
5282 lappend obj_options "additional_flags=-fPIC"
5284 lappend obj_options "additional_flags=-fpic"
5288 if { [istarget "powerpc*-*-aix*"]
5289 || [istarget "rs6000*-*-aix*"]
5290 || [istarget "*-*-cygwin*"]
5291 || [istarget "*-*-mingw*"]
5292 || [istarget "*-*-pe*"] } {
5293 lappend obj_options "additional_flags=-fPIC"
5295 lappend obj_options "additional_flags=-fpic"
5299 lappend obj_options "additional_flags=-fpic"
5302 # don't know what the compiler is...
5303 lappend obj_options "additional_flags=-fPIC"
5307 set outdir [file dirname $dest]
5309 foreach source $sources {
5310 if {[file extension $source] == ".o"} {
5311 # Already a .o file.
5312 lappend objects $source
5316 set sourcebase [file tail $source]
5319 # Gnatmake doesn't like object name foo.adb.o, use foo.o.
5320 set sourcebase [file rootname $sourcebase]
5322 set object ${outdir}/${sourcebase}.o
5325 # Use gdb_compile_ada_1 instead of gdb_compile_ada to avoid the
5327 if {[gdb_compile_ada_1 $source $object object \
5328 $obj_options] != ""} {
5332 if {[gdb_compile $source $object object \
5333 $obj_options] != ""} {
5338 lappend objects $object
5341 set link_options $options
5343 # If we try to use gnatmake for the link, it will interpret the
5344 # object file as an .adb file. Remove ada from the options to
5346 set idx [lsearch $link_options "ada"]
5347 set link_options [lreplace $link_options $idx $idx]
5349 if [test_compiler_info "xlc-*"] {
5350 lappend link_options "additional_flags=-qmkshrobj"
5352 lappend link_options "additional_flags=-shared"
5354 if { ([istarget "*-*-mingw*"]
5355 || [istarget *-*-cygwin*]
5356 || [istarget *-*-pe*]) } {
5357 if { [is_remote host] } {
5358 set name [file tail ${dest}]
5362 lappend link_options "ldflags=-Wl,--out-implib,${name}.a"
5364 # Set the soname of the library. This causes the linker on ELF
5365 # systems to create the DT_NEEDED entry in the executable referring
5366 # to the soname of the library, and not its absolute path. This
5367 # (using the absolute path) would be problem when testing on a
5370 # In conjunction with setting the soname, we add the special
5371 # rpath=$ORIGIN value when building the executable, so that it's
5372 # able to find the library in its own directory.
5373 set destbase [file tail $dest]
5374 lappend link_options "ldflags=-Wl,-soname,$destbase"
5377 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
5380 if { [is_remote host]
5381 && ([istarget "*-*-mingw*"]
5382 || [istarget *-*-cygwin*]
5383 || [istarget *-*-pe*]) } {
5384 set dest_tail_name [file tail ${dest}]
5385 remote_upload host $dest_tail_name.a ${dest}.a
5386 remote_file host delete $dest_tail_name.a
5392 # Ignore FLAGS in target board multilib_flags while executing BODY.
5394 proc with_multilib_flags_filtered { flags body } {
5397 # Ignore flags in multilib_flags.
5398 set board [target_info name]
5399 set multilib_flags_orig [board_info $board multilib_flags]
5400 set multilib_flags ""
5401 foreach op $multilib_flags_orig {
5402 if { [lsearch -exact $flags $op] == -1 } {
5403 append multilib_flags " $op"
5407 save_target_board_info { multilib_flags } {
5408 unset_board_info multilib_flags
5409 set_board_info multilib_flags "$multilib_flags"
5410 set result [uplevel 1 $body]
5416 # Ignore PIE-related flags in target board multilib_flags while executing BODY.
5418 proc with_PIE_multilib_flags_filtered { body } {
5419 set pie_flags [list "-pie" "-no-pie" "-fPIE" "-fno-PIE"]
5420 return [uplevel 1 [list with_multilib_flags_filtered $pie_flags $body]]
5423 # Build a shared library from SOURCES. Ignore target boards PIE-related
5426 proc gdb_compile_shlib {sources dest options} {
5427 with_PIE_multilib_flags_filtered {
5428 set result [gdb_compile_shlib_1 $sources $dest $options]
5434 # This is just like gdb_compile_shlib, above, except that it tries compiling
5435 # against several different thread libraries, to see which one this
5437 proc gdb_compile_shlib_pthreads {sources dest options} {
5439 set why_msg "unrecognized error"
5440 foreach lib {-lpthreads -lpthread -lthread ""} {
5441 # This kind of wipes out whatever libs the caller may have
5442 # set. Or maybe theirs will override ours. How infelicitous.
5443 set options_with_lib [concat $options [list libs=$lib quiet]]
5444 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
5445 switch -regexp -- $ccout {
5446 ".*no posix threads support.*" {
5447 set why_msg "missing threads include file"
5450 ".*cannot open -lpthread.*" {
5451 set why_msg "missing runtime threads library"
5453 ".*Can't find library for -lpthread.*" {
5454 set why_msg "missing runtime threads library"
5457 pass "successfully compiled posix threads shlib test case"
5463 if {!$built_binfile} {
5464 unsupported "couldn't compile $sources: ${why_msg}"
5469 # This is just like gdb_compile_pthreads, above, except that we always add the
5470 # objc library for compiling Objective-C programs
5471 proc gdb_compile_objc {source dest type options} {
5473 set why_msg "unrecognized error"
5474 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
5475 # This kind of wipes out whatever libs the caller may have
5476 # set. Or maybe theirs will override ours. How infelicitous.
5477 if { $lib == "solaris" } {
5478 set lib "-lpthread -lposix4"
5480 if { $lib != "-lobjc" } {
5481 set lib "-lobjc $lib"
5483 set options_with_lib [concat $options [list libs=$lib quiet]]
5484 set ccout [gdb_compile $source $dest $type $options_with_lib]
5485 switch -regexp -- $ccout {
5486 ".*no posix threads support.*" {
5487 set why_msg "missing threads include file"
5490 ".*cannot open -lpthread.*" {
5491 set why_msg "missing runtime threads library"
5493 ".*Can't find library for -lpthread.*" {
5494 set why_msg "missing runtime threads library"
5497 pass "successfully compiled objc with posix threads test case"
5503 if {!$built_binfile} {
5504 unsupported "couldn't compile [file tail $source]: ${why_msg}"
5509 # Build an OpenMP program from SOURCE. See prefatory comment for
5510 # gdb_compile, above, for discussion of the parameters to this proc.
5512 proc gdb_compile_openmp {source dest type options} {
5513 lappend options "additional_flags=-fopenmp"
5514 return [gdb_compile $source $dest $type $options]
5517 # Send a command to GDB.
5518 # For options for TYPE see gdb_stdin_log_write
5520 proc send_gdb { string {type standard}} {
5521 gdb_stdin_log_write $string $type
5522 return [remote_send host "$string"]
5525 # Send STRING to the inferior's terminal.
5527 proc send_inferior { string } {
5528 global inferior_spawn_id
5530 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
5540 proc gdb_expect { args } {
5541 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
5542 set atimeout [lindex $args 0]
5543 set expcode [list [lindex $args 1]]
5548 # A timeout argument takes precedence, otherwise of all the timeouts
5549 # select the largest.
5550 if [info exists atimeout] {
5553 set tmt [get_largest_timeout]
5557 {uplevel remote_expect host $tmt $expcode} string]
5560 global errorInfo errorCode
5562 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
5564 return -code $code $string
5568 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
5570 # Check for long sequence of output by parts.
5571 # TEST: is the test message to be printed with the test success/fail.
5572 # SENTINEL: Is the terminal pattern indicating that output has finished.
5573 # LIST: is the sequence of outputs to match.
5574 # If the sentinel is recognized early, it is considered an error.
5577 # 1 if the test failed,
5578 # 0 if the test passes,
5579 # -1 if there was an internal error.
5581 proc gdb_expect_list {test sentinel list} {
5586 while { ${index} < [llength ${list}] } {
5587 set pattern [lindex ${list} ${index}]
5588 set index [expr ${index} + 1]
5589 verbose -log "gdb_expect_list pattern: /$pattern/" 2
5590 if { ${index} == [llength ${list}] } {
5593 -re "${pattern}${sentinel}" {
5594 # pass "${test}, pattern ${index} + sentinel"
5597 fail "${test} (pattern ${index} + sentinel)"
5600 -re ".*A problem internal to GDB has been detected" {
5601 fail "${test} (GDB internal error)"
5603 gdb_internal_error_resync
5606 fail "${test} (pattern ${index} + sentinel) (timeout)"
5611 # unresolved "${test}, pattern ${index} + sentinel"
5617 # pass "${test}, pattern ${index}"
5620 fail "${test} (pattern ${index})"
5623 -re ".*A problem internal to GDB has been detected" {
5624 fail "${test} (GDB internal error)"
5626 gdb_internal_error_resync
5629 fail "${test} (pattern ${index}) (timeout)"
5634 # unresolved "${test}, pattern ${index}"
5646 # Spawn the gdb process.
5648 # This doesn't expect any output or do any other initialization,
5649 # leaving those to the caller.
5651 # Overridable function -- you can override this function in your
5654 proc gdb_spawn { } {
5658 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
5660 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
5663 set saved_gdbflags $GDBFLAGS
5665 if {$GDBFLAGS != ""} {
5668 append GDBFLAGS $cmdline_flags
5672 set GDBFLAGS $saved_gdbflags
5677 # Start gdb running, wait for prompt, and disable the pagers.
5679 # Overridable function -- you can override this function in your
5682 proc gdb_start { } {
5687 catch default_gdb_exit
5690 # Return true if we can spawn a program on the target and attach to
5693 proc can_spawn_for_attach { } {
5694 # We use exp_pid to get the inferior's pid, assuming that gives
5695 # back the pid of the program. On remote boards, that would give
5696 # us instead the PID of e.g., the ssh client, etc.
5697 if {[is_remote target]} {
5698 verbose -log "can't spawn for attach (target is remote)"
5702 # The "attach" command doesn't make sense when the target is
5703 # stub-like, where GDB finds the program already started on
5704 # initial connection.
5705 if {[target_info exists use_gdb_stub]} {
5706 verbose -log "can't spawn for attach (target is stub)"
5714 # Centralize the failure checking of "attach" command.
5715 # Return 0 if attach failed, otherwise return 1.
5717 proc gdb_attach { testpid args } {
5722 if { [llength $args] != 0 } {
5723 error "Unexpected arguments: $args"
5726 gdb_test_multiple "attach $testpid" "attach" {
5727 -re -wrap "Attaching to.*ptrace: Operation not permitted\\." {
5728 unsupported "$gdb_test_name (Operation not permitted)"
5731 -re -wrap "$pattern" {
5740 # Start gdb with "--pid $TESTPID" on the command line and wait for the prompt.
5741 # Return 1 if GDB managed to start and attach to the process, 0 otherwise.
5743 proc_with_prefix gdb_spawn_attach_cmdline { testpid } {
5744 if ![can_spawn_for_attach] {
5745 # The caller should have checked can_spawn_for_attach itself
5746 # before getting here.
5747 error "can't spawn for attach with this target/board"
5750 set test "start gdb with --pid"
5751 set res [gdb_spawn_with_cmdline_opts "-quiet --pid=$testpid"]
5757 gdb_test_multiple "" "$test" {
5758 -re -wrap "ptrace: Operation not permitted\\." {
5759 unsupported "$gdb_test_name (operation not permitted)"
5762 -re -wrap "ptrace: No such process\\." {
5763 fail "$gdb_test_name (no such process)"
5766 -re -wrap "Attaching to process $testpid\r\n.*" {
5771 # Check that we actually attached to a process, in case the
5772 # error message is not caught by the patterns above.
5773 gdb_test_multiple "info thread" "" {
5774 -re -wrap "No threads\\." {
5775 fail "$gdb_test_name (no thread)"
5786 # Kill a progress previously started with spawn_wait_for_attach, and
5787 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
5790 proc kill_wait_spawned_process { proc_spawn_id } {
5791 set pid [exp_pid -i $proc_spawn_id]
5793 verbose -log "killing ${pid}"
5794 remote_exec build "kill -9 ${pid}"
5796 verbose -log "closing ${proc_spawn_id}"
5797 catch "close -i $proc_spawn_id"
5798 verbose -log "waiting for ${proc_spawn_id}"
5800 # If somehow GDB ends up still attached to the process here, a
5801 # blocking wait hangs until gdb is killed (or until gdb / the
5802 # ptracer reaps the exit status too, but that won't happen because
5803 # something went wrong.) Passing -nowait makes expect tell Tcl to
5804 # wait for the PID in the background. That's fine because we
5805 # don't care about the exit status. */
5806 wait -nowait -i $proc_spawn_id
5809 # Returns the process id corresponding to the given spawn id.
5811 proc spawn_id_get_pid { spawn_id } {
5812 set testpid [exp_pid -i $spawn_id]
5814 if { [istarget "*-*-cygwin*"] } {
5815 # testpid is the Cygwin PID, GDB uses the Windows PID, which
5816 # might be different due to the way fork/exec works.
5817 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
5823 # Start a set of programs running and then wait for a bit, to be sure
5824 # that they can be attached to. Return a list of processes spawn IDs,
5825 # one element for each process spawned. It's a test error to call
5826 # this when [can_spawn_for_attach] is false.
5828 proc spawn_wait_for_attach { executable_list } {
5829 set spawn_id_list {}
5831 if ![can_spawn_for_attach] {
5832 # The caller should have checked can_spawn_for_attach itself
5833 # before getting here.
5834 error "can't spawn for attach with this target/board"
5837 foreach {executable} $executable_list {
5838 # Note we use Expect's spawn, not Tcl's exec, because with
5839 # spawn we control when to wait for/reap the process. That
5840 # allows killing the process by PID without being subject to
5842 lappend spawn_id_list [remote_spawn target $executable]
5847 return $spawn_id_list
5851 # gdb_load_cmd -- load a file into the debugger.
5852 # ARGS - additional args to load command.
5853 # return a -1 if anything goes wrong.
5855 proc gdb_load_cmd { args } {
5858 if [target_info exists gdb_load_timeout] {
5859 set loadtimeout [target_info gdb_load_timeout]
5861 set loadtimeout 1600
5863 send_gdb "load $args\n"
5864 verbose "Timeout is now $loadtimeout seconds" 2
5865 gdb_expect $loadtimeout {
5866 -re "Loading section\[^\r\]*\r\n" {
5869 -re "Start address\[\r\]*\r\n" {
5872 -re "Transfer rate\[\r\]*\r\n" {
5875 -re "Memory access error\[^\r\]*\r\n" {
5876 perror "Failed to load program"
5879 -re "$gdb_prompt $" {
5882 -re "(.*)\r\n$gdb_prompt " {
5883 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
5887 perror "Timed out trying to load $args."
5894 # Invoke "gcore". CORE is the name of the core file to write. TEST
5895 # is the name of the test case. This will return 1 if the core file
5896 # was created, 0 otherwise. If this fails to make a core file because
5897 # this configuration of gdb does not support making core files, it
5898 # will call "unsupported", not "fail". However, if this fails to make
5899 # a core file for some other reason, then it will call "fail".
5901 proc gdb_gcore_cmd {core test} {
5906 set re_unsupported \
5907 "(?:Can't create a corefile|Target does not support core file generation\\.)"
5909 with_timeout_factor 3 {
5910 gdb_test_multiple "gcore $core" $test {
5911 -re -wrap "Saved corefile .*" {
5915 -re -wrap $re_unsupported {
5924 # Load core file CORE. TEST is the name of the test case.
5925 # This will record a pass/fail for loading the core file.
5927 # 1 - core file is successfully loaded
5928 # 0 - core file loaded but has a non fatal error
5929 # -1 - core file failed to load
5931 proc gdb_core_cmd { core test } {
5934 gdb_test_multiple "core $core" "$test" {
5935 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
5938 -re " is not a core dump:.*\r\n$gdb_prompt $" {
5939 fail "$test (bad file format)"
5942 -re -wrap "[string_to_regexp $core]: No such file or directory.*" {
5943 fail "$test (file not found)"
5946 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
5947 fail "$test (incomplete note section)"
5950 -re "Core was generated by .*\r\n$gdb_prompt $" {
5954 -re ".*$gdb_prompt $" {
5959 fail "$test (timeout)"
5963 fail "unsupported output from 'core' command"
5967 # Return the filename to download to the target and load on the target
5968 # for this shared library. Normally just LIBNAME, unless shared libraries
5969 # for this target have separate link and load images.
5971 proc shlib_target_file { libname } {
5975 # Return the filename GDB will load symbols from when debugging this
5976 # shared library. Normally just LIBNAME, unless shared libraries for
5977 # this target have separate link and load images.
5979 proc shlib_symbol_file { libname } {
5983 # Return the filename to download to the target and load for this
5984 # executable. Normally just BINFILE unless it is renamed to something
5985 # else for this target.
5987 proc exec_target_file { binfile } {
5991 # Return the filename GDB will load symbols from when debugging this
5992 # executable. Normally just BINFILE unless executables for this target
5993 # have separate files for symbols.
5995 proc exec_symbol_file { binfile } {
5999 # Rename the executable file. Normally this is just BINFILE1 being renamed
6000 # to BINFILE2, but some targets require multiple binary files.
6001 proc gdb_rename_execfile { binfile1 binfile2 } {
6002 file rename -force [exec_target_file ${binfile1}] \
6003 [exec_target_file ${binfile2}]
6004 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
6005 file rename -force [exec_symbol_file ${binfile1}] \
6006 [exec_symbol_file ${binfile2}]
6010 # "Touch" the executable file to update the date. Normally this is just
6011 # BINFILE, but some targets require multiple files.
6012 proc gdb_touch_execfile { binfile } {
6013 set time [clock seconds]
6014 file mtime [exec_target_file ${binfile}] $time
6015 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
6016 file mtime [exec_symbol_file ${binfile}] $time
6020 # Override of dejagnu's remote_upload, which doesn't handle remotedir.
6022 rename remote_upload dejagnu_remote_upload
6023 proc remote_upload { dest srcfile args } {
6024 if { [is_remote $dest] && [board_info $dest exists remotedir] } {
6025 set remotedir [board_info $dest remotedir]
6026 if { ![string match "$remotedir*" $srcfile] } {
6027 # Use hardcoded '/' as separator, as in dejagnu's remote_download.
6028 set srcfile $remotedir/$srcfile
6032 return [dejagnu_remote_upload $dest $srcfile {*}$args]
6035 # Like remote_download but provides a gdb-specific behavior.
6037 # If the destination board is remote, the local file FROMFILE is transferred as
6038 # usual with remote_download to TOFILE on the remote board. The destination
6039 # filename is added to the CLEANFILES global, so it can be cleaned up at the
6042 # If the destination board is local, the destination path TOFILE is passed
6043 # through standard_output_file, and FROMFILE is copied there.
6045 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
6048 proc gdb_remote_download {dest fromfile {tofile {}}} {
6049 # If TOFILE is not given, default to the same filename as FROMFILE.
6050 if {[string length $tofile] == 0} {
6051 set tofile [file tail $fromfile]
6054 if {[is_remote $dest]} {
6055 # When the DEST is remote, we simply send the file to DEST.
6056 global cleanfiles_target cleanfiles_host
6058 set destname [remote_download $dest $fromfile $tofile]
6059 if { $dest == "target" } {
6060 lappend cleanfiles_target $destname
6061 } elseif { $dest == "host" } {
6062 lappend cleanfiles_host $destname
6067 # When the DEST is local, we copy the file to the test directory (where
6068 # the executable is).
6070 # Note that we pass TOFILE through standard_output_file, regardless of
6071 # whether it is absolute or relative, because we don't want the tests
6072 # to be able to write outside their standard output directory.
6074 set tofile [standard_output_file $tofile]
6076 file copy -force $fromfile $tofile
6082 # Copy shlib FILE to the target.
6084 proc gdb_download_shlib { file } {
6085 set target_file [shlib_target_file $file]
6086 if { [is_remote host] } {
6087 remote_download host $target_file
6089 return [gdb_remote_download target $target_file]
6092 # Set solib-search-path to allow gdb to locate shlib FILE.
6094 proc gdb_locate_shlib { file } {
6097 if ![info exists gdb_spawn_id] {
6098 perror "gdb_load_shlib: GDB is not running"
6101 if { [is_remote target] || [is_remote host] } {
6102 # If the target or host is remote, we need to tell gdb where to find
6108 # We could set this even when not testing remotely, but a user
6109 # generally won't set it unless necessary. In order to make the tests
6110 # more like the real-life scenarios, we don't set it for local testing.
6111 if { [is_remote host] } {
6112 set solib_search_path [board_info host remotedir]
6113 if { $solib_search_path == "" } {
6114 set solib_search_path .
6117 set solib_search_path [file dirname $file]
6120 gdb_test_no_output "set solib-search-path $solib_search_path" \
6121 "set solib-search-path for [file tail $file]"
6124 # Copy shlib FILE to the target and set solib-search-path to allow gdb to
6127 proc gdb_load_shlib { file } {
6128 set dest [gdb_download_shlib $file]
6129 gdb_locate_shlib $file
6134 # gdb_load -- load a file into the debugger. Specifying no file
6135 # defaults to the executable currently being debugged.
6136 # The return value is 0 for success, -1 for failure.
6137 # Many files in config/*.exp override this procedure.
6139 proc gdb_load { arg } {
6141 return [gdb_file_cmd $arg]
6147 # with_set -- Execute BODY and set VAR temporary to VAL for the
6150 proc with_set { var val body } {
6153 "is (\[^\r\n\]+)\\."
6154 gdb_test_multiple "show $var" "" {
6155 -re -wrap $show_re {
6156 set save $expect_out(1,string)
6160 # Handle 'set to "auto" (currently "i386")'.
6161 set save [regsub {^set to} $save ""]
6162 set save [regsub {\([^\r\n]+\)$} $save ""]
6163 set save [string trim $save]
6164 set save [regsub -all {^"|"$} $save ""]
6166 if { $save == "" } {
6167 perror "Did not manage to set $var"
6170 set cmd "set $var $val"
6171 gdb_test_multiple $cmd "" {
6174 -re -wrap " is set to \"?$val\"?\\." {
6179 set code [catch {uplevel 1 $body} result]
6181 # Restore saved setting.
6182 if { $save != "" } {
6183 set cmd "set $var $save"
6184 gdb_test_multiple $cmd "" {
6187 -re -wrap "is set to \"?$save\"?( \\(\[^)\]*\\))?\\." {
6193 global errorInfo errorCode
6194 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
6196 return -code $code $result
6201 # with_complaints -- Execute BODY and set complaints temporary to N for the
6204 proc with_complaints { n body } {
6205 return [uplevel [list with_set complaints $n $body]]
6209 # gdb_load_no_complaints -- As gdb_load, but in addition verifies that
6210 # loading caused no symbol reading complaints.
6212 proc gdb_load_no_complaints { arg } {
6213 global gdb_prompt gdb_file_cmd_msg decimal
6215 # Temporarily set complaint to a small non-zero number.
6220 # Verify that there were no complaints.
6223 "^(Reading symbols from \[^\r\n\]*" \
6224 ")+(Expanding full symbols from \[^\r\n\]*" \
6226 gdb_assert {[regexp $re $gdb_file_cmd_msg]} "No complaints"
6229 # gdb_reload -- load a file into the target. Called before "running",
6230 # either the first time or after already starting the program once,
6231 # for remote targets. Most files that override gdb_load should now
6232 # override this instead.
6234 # INFERIOR_ARGS contains the arguments to pass to the inferiors, as a
6235 # single string to get interpreted by a shell. If the target board
6236 # overriding gdb_reload is a "stub", then it should arrange things such
6237 # these arguments make their way to the inferior process.
6239 proc gdb_reload { {inferior_args {}} } {
6240 # For the benefit of existing configurations, default to gdb_load.
6241 # Specifying no file defaults to the executable currently being
6243 return [gdb_load ""]
6246 proc gdb_continue { function } {
6249 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
6252 # Default implementation of gdb_init.
6253 proc default_gdb_init { test_file_name } {
6254 global gdb_wrapper_initialized
6255 global gdb_wrapper_target
6256 global gdb_test_file_name
6257 global cleanfiles_target
6258 global cleanfiles_host
6261 # Reset the timeout value to the default. This way, any testcase
6262 # that changes the timeout value without resetting it cannot affect
6263 # the timeout used in subsequent testcases.
6264 global gdb_test_timeout
6266 set timeout $gdb_test_timeout
6268 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
6269 && [target_info exists gdb_reverse_timeout] } {
6270 set timeout [target_info gdb_reverse_timeout]
6273 # If GDB_INOTIFY is given, check for writes to '.'. This is a
6274 # debugging tool to help confirm that the test suite is
6275 # parallel-safe. You need "inotifywait" from the
6276 # inotify-tools package to use this.
6277 global GDB_INOTIFY inotify_pid
6278 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
6279 global outdir tool inotify_log_file
6281 set exclusions {outputs temp gdb[.](log|sum) cache}
6282 set exclusion_re ([join $exclusions |])
6284 set inotify_log_file [standard_temp_file inotify.out]
6285 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
6286 --exclude $exclusion_re \
6287 |& tee -a $outdir/$tool.log $inotify_log_file &]
6289 # Wait for the watches; hopefully this is long enough.
6292 # Clear the log so that we don't emit a warning the first time
6294 set fd [open $inotify_log_file w]
6298 # Block writes to all banned variables, and invocation of all
6299 # banned procedures...
6300 global banned_variables
6301 global banned_procedures
6302 global banned_traced
6303 if (!$banned_traced) {
6304 foreach banned_var $banned_variables {
6305 global "$banned_var"
6306 trace add variable "$banned_var" write error
6308 foreach banned_proc $banned_procedures {
6309 global "$banned_proc"
6310 trace add execution "$banned_proc" enter error
6315 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
6316 # messages as expected.
6321 # Don't let a .inputrc file or an existing setting of INPUTRC mess
6322 # up the test results. Certain tests (style tests and TUI tests)
6323 # want to set the terminal to a non-"dumb" value, and for those we
6324 # want to disable bracketed paste mode. Versions of Readline
6325 # before 8.0 will not understand this and will issue a warning.
6326 # We tried using a $if to guard it, but Readline 8.1 had a bug in
6327 # its version-comparison code that prevented this for working.
6328 setenv INPUTRC [cached_file inputrc "set enable-bracketed-paste off"]
6330 # This disables style output, which would interfere with many
6334 # If DEBUGINFOD_URLS is set, gdb will try to download sources and
6335 # debug info for f.i. system libraries. Prevent this.
6336 if { [is_remote host] } {
6337 # See initialization of INTERNAL_GDBFLAGS.
6339 # Using "set debuginfod enabled off" in INTERNAL_GDBFLAGS interferes
6340 # with the gdb.debuginfod test-cases, so use the unsetenv method for
6342 unset -nocomplain ::env(DEBUGINFOD_URLS)
6345 # Ensure that GDBHISTFILE and GDBHISTSIZE are removed from the
6346 # environment, we don't want these modifications to the history
6348 unset -nocomplain ::env(GDBHISTFILE)
6349 unset -nocomplain ::env(GDBHISTSIZE)
6351 # Ensure that XDG_CONFIG_HOME is not set. Some tests setup a fake
6352 # home directory in order to test loading settings from gdbinit.
6353 # If XDG_CONFIG_HOME is set then GDB will load a gdbinit from
6354 # there (if one is present) rather than the home directory setup
6356 unset -nocomplain ::env(XDG_CONFIG_HOME)
6358 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
6359 # during startup. See "man expect" for details about stty_init.
6361 set stty_init "rows 25 cols 80"
6363 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
6364 # grep. Clear GREP_OPTIONS to make the behavior predictable,
6365 # especially having color output turned on can cause tests to fail.
6366 setenv GREP_OPTIONS ""
6368 # Clear $gdbserver_reconnect_p.
6369 global gdbserver_reconnect_p
6370 set gdbserver_reconnect_p 1
6371 unset gdbserver_reconnect_p
6373 # Clear $last_loaded_file
6374 global last_loaded_file
6375 unset -nocomplain last_loaded_file
6377 # Reset GDB number of instances
6378 global gdb_instances
6381 set cleanfiles_target {}
6382 set cleanfiles_host {}
6384 set gdb_test_file_name [file rootname [file tail $test_file_name]]
6386 # Make sure that the wrapper is rebuilt
6387 # with the appropriate multilib option.
6388 if { $gdb_wrapper_target != [current_target_name] } {
6389 set gdb_wrapper_initialized 0
6392 # Unlike most tests, we have a small number of tests that generate
6393 # a very large amount of output. We therefore increase the expect
6394 # buffer size to be able to contain the entire test output. This
6395 # is especially needed by gdb.base/info-macros.exp.
6397 # Also set this value for the currently running GDB.
6398 match_max [match_max -d]
6400 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
6401 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
6404 if [target_info exists gdb_prompt] {
6405 set gdb_prompt [target_info gdb_prompt]
6407 set gdb_prompt "\\(gdb\\)"
6410 if [info exists use_gdb_stub] {
6414 gdb_setup_known_globals
6416 if { [info procs ::gdb_tcl_unknown] != "" } {
6417 # Dejagnu overrides proc unknown. The dejagnu version may trigger in a
6418 # test-case but abort the entire test run. To fix this, we install a
6419 # local version here, which reverts dejagnu's override, and restore
6420 # dejagnu's version in gdb_finish.
6421 rename ::unknown ::dejagnu_unknown
6422 proc unknown { args } {
6423 # Use tcl's unknown.
6424 set cmd [lindex $args 0]
6425 unresolved "testcase aborted due to invalid command name: $cmd"
6426 return [uplevel 1 ::gdb_tcl_unknown $args]
6431 # Return a path using GDB_PARALLEL.
6432 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
6433 # GDB_PARALLEL must be defined, the caller must check.
6435 # The default value for GDB_PARALLEL is, canonically, ".".
6436 # The catch is that tests don't expect an additional "./" in file paths so
6437 # omit any directory for the default case.
6438 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
6439 # its special handling.
6441 proc make_gdb_parallel_path { args } {
6442 global GDB_PARALLEL objdir
6443 set joiner [list "file" "join" $objdir]
6444 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
6445 lappend joiner $GDB_PARALLEL
6447 set joiner [concat $joiner $args]
6448 return [eval $joiner]
6451 # Turn BASENAME into a full file name in the standard output
6452 # directory. It is ok if BASENAME is the empty string; in this case
6453 # the directory is returned.
6455 proc standard_output_file {basename} {
6456 global objdir subdir gdb_test_file_name
6458 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
6460 # If running on MinGW, replace /c/foo with c:/foo
6461 if { [ishost *-*-mingw*] } {
6462 set dir [exec sh -c "cd ${dir} && pwd -W"]
6464 return [file join $dir $basename]
6467 # Turn BASENAME into a file name on host.
6469 proc host_standard_output_file { basename } {
6470 if { [is_remote host] } {
6471 set remotedir [board_info host remotedir]
6472 if { $remotedir == "" } {
6473 if { $basename == "" } {
6478 return [join [list $remotedir $basename] "/"]
6481 return [standard_output_file $basename]
6485 # Turn BASENAME into a full file name in the standard output directory. If
6486 # GDB has been launched more than once then append the count, starting with
6489 proc standard_output_file_with_gdb_instance {basename} {
6490 global gdb_instances
6491 set count $gdb_instances
6494 return [standard_output_file $basename]
6496 return [standard_output_file ${basename}.${count}]
6499 # Return the name of a file in our standard temporary directory.
6501 proc standard_temp_file {basename} {
6502 # Since a particular runtest invocation is only executing a single test
6503 # file at any given time, we can use the runtest pid to build the
6504 # path of the temp directory.
6505 set dir [make_gdb_parallel_path temp [pid]]
6507 return [file join $dir $basename]
6510 # Rename file A to file B, if B does not already exists. Otherwise, leave B
6511 # as is and delete A. Return 1 if rename happened.
6513 proc tentative_rename { a b } {
6514 global errorInfo errorCode
6515 set code [catch {file rename -- $a $b} result]
6516 if { $code == 1 && [lindex $errorCode 0] == "POSIX" \
6517 && [lindex $errorCode 1] == "EEXIST" } {
6522 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
6523 } elseif {$code > 1} {
6524 return -code $code $result
6529 # Create a file with name FILENAME and contents TXT in the cache directory.
6530 # If EXECUTABLE, mark the new file for execution.
6532 proc cached_file { filename txt {executable 0}} {
6533 set filename [make_gdb_parallel_path cache $filename]
6535 if { [file exists $filename] } {
6539 set dir [file dirname $filename]
6542 set tmp_filename $filename.[pid]
6543 set fd [open $tmp_filename w]
6547 if { $executable } {
6548 exec chmod +x $tmp_filename
6550 tentative_rename $tmp_filename $filename
6555 # Return a wrapper around gdb that prevents generating a core file.
6557 proc gdb_no_core { } {
6561 [join [list exec $::GDB {"$@"}]]]
6562 set script [join $script "\n"]
6563 return [cached_file gdb-no-core.sh $script 1]
6566 # Set 'testfile', 'srcfile', and 'binfile'.
6568 # ARGS is a list of source file specifications.
6569 # Without any arguments, the .exp file's base name is used to
6570 # compute the source file name. The ".c" extension is added in this case.
6571 # If ARGS is not empty, each entry is a source file specification.
6572 # If the specification starts with a "." or "-", it is treated as a suffix
6573 # to append to the .exp file's base name.
6574 # If the specification is the empty string, it is treated as if it
6576 # Otherwise it is a file name.
6577 # The first file in the list is used to set the 'srcfile' global.
6578 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
6580 # Most tests should call this without arguments.
6582 # If a completely different binary file name is needed, then it
6583 # should be handled in the .exp file with a suitable comment.
6585 proc standard_testfile {args} {
6586 global gdb_test_file_name
6588 global gdb_test_file_last_vars
6591 global testfile binfile
6593 set testfile $gdb_test_file_name
6594 set binfile [standard_output_file ${testfile}]
6596 if {[llength $args] == 0} {
6600 # Unset our previous output variables.
6601 # This can help catch hidden bugs.
6602 if {[info exists gdb_test_file_last_vars]} {
6603 foreach varname $gdb_test_file_last_vars {
6605 catch {unset $varname}
6608 # 'executable' is often set by tests.
6609 set gdb_test_file_last_vars {executable}
6613 set varname srcfile$suffix
6616 # Handle an extension.
6620 set first [string range $arg 0 0]
6621 if { $first == "." || $first == "-" } {
6622 set arg $testfile$arg
6627 lappend gdb_test_file_last_vars $varname
6629 if {$suffix == ""} {
6637 # The default timeout used when testing GDB commands. We want to use
6638 # the same timeout as the default dejagnu timeout, unless the user has
6639 # already provided a specific value (probably through a site.exp file).
6640 global gdb_test_timeout
6641 if ![info exists gdb_test_timeout] {
6642 set gdb_test_timeout $timeout
6645 # A list of global variables that GDB testcases should not use.
6646 # We try to prevent their use by monitoring write accesses and raising
6647 # an error when that happens.
6648 set banned_variables { bug_id prms_id }
6650 # A list of procedures that GDB testcases should not use.
6651 # We try to prevent their use by monitoring invocations and raising
6652 # an error when that happens.
6653 set banned_procedures { strace }
6655 # gdb_init is called by runtest at start, but also by several
6656 # tests directly; gdb_finish is only called from within runtest after
6657 # each test source execution.
6658 # Placing several traces by repetitive calls to gdb_init leads
6659 # to problems, as only one trace is removed in gdb_finish.
6660 # To overcome this possible problem, we add a variable that records
6661 # if the banned variables and procedures are already traced.
6664 # Global array that holds the name of all global variables at the time
6665 # a test script is started. After the test script has completed any
6666 # global not in this list is deleted.
6667 array set gdb_known_globals {}
6669 # Setup the GDB_KNOWN_GLOBALS array with the names of all current
6671 proc gdb_setup_known_globals {} {
6672 global gdb_known_globals
6674 array set gdb_known_globals {}
6675 foreach varname [info globals] {
6676 set gdb_known_globals($varname) 1
6680 # Cleanup the global namespace. Any global not in the
6681 # GDB_KNOWN_GLOBALS array is unset, this ensures we don't "leak"
6682 # globals from one test script to another.
6683 proc gdb_cleanup_globals {} {
6684 global gdb_known_globals gdb_persistent_globals
6686 foreach varname [info globals] {
6687 if {![info exists gdb_known_globals($varname)]} {
6688 if { [info exists gdb_persistent_globals($varname)] } {
6691 uplevel #0 unset $varname
6696 # Create gdb_tcl_unknown, a copy tcl's ::unknown, provided it's present as a
6698 set temp [interp create]
6699 if { [interp eval $temp "info procs ::unknown"] != "" } {
6700 set old_args [interp eval $temp "info args ::unknown"]
6701 set old_body [interp eval $temp "info body ::unknown"]
6702 eval proc gdb_tcl_unknown {$old_args} {$old_body}
6707 # GDB implementation of ${tool}_init. Called right before executing the
6709 # Overridable function -- you can override this function in your
6711 proc gdb_init { args } {
6712 # A baseboard file overriding this proc and calling the default version
6713 # should behave the same as this proc. So, don't add code here, but to
6714 # the default version instead.
6715 return [default_gdb_init {*}$args]
6718 # GDB implementation of ${tool}_finish. Called right after executing the
6720 proc gdb_finish { } {
6721 global gdbserver_reconnect_p
6723 global cleanfiles_target
6724 global cleanfiles_host
6725 global known_globals
6727 if { [info procs ::gdb_tcl_unknown] != "" } {
6728 # Restore dejagnu's version of proc unknown.
6730 rename ::dejagnu_unknown ::unknown
6733 # Exit first, so that the files are no longer in use.
6736 if { [llength $cleanfiles_target] > 0 } {
6737 eval remote_file target delete $cleanfiles_target
6738 set cleanfiles_target {}
6740 if { [llength $cleanfiles_host] > 0 } {
6741 eval remote_file host delete $cleanfiles_host
6742 set cleanfiles_host {}
6745 # Unblock write access to the banned variables. Dejagnu typically
6746 # resets some of them between testcases.
6747 global banned_variables
6748 global banned_procedures
6749 global banned_traced
6750 if ($banned_traced) {
6751 foreach banned_var $banned_variables {
6752 global "$banned_var"
6753 trace remove variable "$banned_var" write error
6755 foreach banned_proc $banned_procedures {
6756 global "$banned_proc"
6757 trace remove execution "$banned_proc" enter error
6762 global gdb_finish_hooks
6763 foreach gdb_finish_hook $gdb_finish_hooks {
6766 set gdb_finish_hooks [list]
6772 set debug_format "unknown"
6774 # Run the gdb command "info source" and extract the debugging format
6775 # information from the output and save it in debug_format.
6777 proc get_debug_format { } {
6782 set debug_format "unknown"
6783 send_gdb "info source\n"
6785 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
6786 set debug_format $expect_out(1,string)
6787 verbose "debug format is $debug_format"
6790 -re "No current source file.\r\n$gdb_prompt $" {
6791 perror "get_debug_format used when no current source file"
6794 -re "$gdb_prompt $" {
6795 warning "couldn't check debug format (no valid response)."
6799 warning "couldn't check debug format (timeout)."
6805 # Return true if FORMAT matches the debug format the current test was
6806 # compiled with. FORMAT is a shell-style globbing pattern; it can use
6807 # `*', `[...]', and so on.
6809 # This function depends on variables set by `get_debug_format', above.
6811 proc test_debug_format {format} {
6814 return [expr [string match $format $debug_format] != 0]
6817 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
6818 # COFF, stabs, etc). If that format matches the format that the
6819 # current test was compiled with, then the next test is expected to
6820 # fail for any target. Returns 1 if the next test or set of tests is
6821 # expected to fail, 0 otherwise (or if it is unknown). Must have
6822 # previously called get_debug_format.
6823 proc setup_xfail_format { format } {
6824 set ret [test_debug_format $format]
6832 # gdb_get_line_number TEXT [FILE]
6834 # Search the source file FILE, and return the line number of the
6835 # first line containing TEXT. If no match is found, an error is thrown.
6837 # TEXT is a string literal, not a regular expression.
6839 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
6840 # specified, and does not start with "/", then it is assumed to be in
6841 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
6842 # by changing the callers and the interface at the same time.
6843 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
6844 # gdb.base/ena-dis-br.exp.
6846 # Use this function to keep your test scripts independent of the
6847 # exact line numbering of the source file. Don't write:
6849 # send_gdb "break 20"
6851 # This means that if anyone ever edits your test's source file,
6852 # your test could break. Instead, put a comment like this on the
6853 # source file line you want to break at:
6855 # /* breakpoint spot: frotz.exp: test name */
6857 # and then write, in your test script (which we assume is named
6860 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
6862 # (Yes, Tcl knows how to handle the nested quotes and brackets.
6865 # % puts "foo [lindex "bar baz" 1]"
6868 # Tcl is quite clever, for a little stringy language.)
6872 # The previous implementation of this procedure used the gdb search command.
6873 # This version is different:
6875 # . It works with MI, and it also works when gdb is not running.
6877 # . It operates on the build machine, not the host machine.
6879 # . For now, this implementation fakes a current directory of
6880 # $srcdir/$subdir to be compatible with the old implementation.
6881 # This will go away eventually and some callers will need to
6884 # . The TEXT argument is literal text and matches literally,
6885 # not a regular expression as it was before.
6887 # . State changes in gdb, such as changing the current file
6888 # and setting $_, no longer happen.
6890 # After a bit of time we can forget about the differences from the
6891 # old implementation.
6893 # --chastain 2004-08-05
6895 proc gdb_get_line_number { text { file "" } } {
6900 if {"$file" == ""} {
6903 if {![regexp "^/" "$file"]} {
6904 set file "$srcdir/$subdir/$file"
6907 if {[catch { set fd [open "$file"] } message]} {
6912 for { set line 1 } { 1 } { incr line } {
6913 if {[catch { set nchar [gets "$fd" body] } message]} {
6919 if {[string first "$text" "$body"] >= 0} {
6925 if {[catch { close "$fd" } message]} {
6930 error "undefined tag \"$text\""
6936 # Continue the program until it ends.
6938 # MSSG is the error message that gets printed. If not given, a
6940 # COMMAND is the command to invoke. If not given, "continue" is
6942 # ALLOW_EXTRA is a flag indicating whether the test should expect
6943 # extra output between the "Continuing." line and the program
6944 # exiting. By default it is zero; if nonzero, any extra output
6947 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
6948 global inferior_exited_re use_gdb_stub
6951 set text "continue until exit"
6953 set text "continue until exit at $mssg"
6961 # By default, we don't rely on exit() behavior of remote stubs --
6962 # it's common for exit() to be implemented as a simple infinite
6963 # loop, or a forced crash/reset. For native targets, by default, we
6964 # assume process exit is reported as such. If a non-reliable target
6965 # is used, we set a breakpoint at exit, and continue to that.
6966 if { [target_info exists exit_is_reliable] } {
6967 set exit_is_reliable [target_info exit_is_reliable]
6969 set exit_is_reliable [expr ! $use_gdb_stub]
6972 if { ! $exit_is_reliable } {
6973 if {![gdb_breakpoint "exit"]} {
6976 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
6979 # Continue until we exit. Should not stop again.
6980 # Don't bother to check the output of the program, that may be
6981 # extremely tough for some remote systems.
6983 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
6988 proc rerun_to_main {} {
6989 global gdb_prompt use_gdb_stub
6994 -re ".*Breakpoint .*main .*$gdb_prompt $"\
6995 {pass "rerun to main" ; return 0}
6996 -re "$gdb_prompt $"\
6997 {fail "rerun to main" ; return 0}
6998 timeout {fail "(timeout) rerun to main" ; return 0}
7003 -re "The program .* has been started already.*y or n. $" {
7004 send_gdb "y\n" answer
7007 -re "Starting program.*$gdb_prompt $"\
7008 {pass "rerun to main" ; return 0}
7009 -re "$gdb_prompt $"\
7010 {fail "rerun to main" ; return 0}
7011 timeout {fail "(timeout) rerun to main" ; return 0}
7016 # Return true if EXECUTABLE contains a .gdb_index or .debug_names index section.
7018 proc exec_has_index_section { executable } {
7019 set readelf_program [gdb_find_readelf]
7020 set res [catch {exec $readelf_program -S $executable \
7021 | grep -E "\.gdb_index|\.debug_names" }]
7028 # Return list with major and minor version of readelf, or an empty list.
7029 gdb_caching_proc readelf_version {} {
7030 set readelf_program [gdb_find_readelf]
7031 set res [catch {exec $readelf_program --version} output]
7035 set lines [split $output \n]
7036 set line [lindex $lines 0]
7037 set res [regexp {[ \t]+([0-9]+)[.]([0-9]+)[^ \t]*$} \
7038 $line dummy major minor]
7042 return [list $major $minor]
7045 # Return 1 if readelf prints the PIE flag, 0 if is doesn't, and -1 if unknown.
7046 proc readelf_prints_pie { } {
7047 set version [readelf_version]
7048 if { [llength $version] == 0 } {
7051 set major [lindex $version 0]
7052 set minor [lindex $version 1]
7053 # It would be better to construct a PIE executable and test if the PIE
7054 # flag is printed by readelf, but we cannot reliably construct a PIE
7055 # executable if the multilib_flags dictate otherwise
7056 # (--target_board=unix/-no-pie/-fno-PIE).
7057 return [version_compare {2 26} <= [list $major $minor]]
7060 # Return 1 if EXECUTABLE is a Position Independent Executable, 0 if it is not,
7061 # and -1 if unknown.
7063 proc exec_is_pie { executable } {
7064 set res [readelf_prints_pie]
7068 set readelf_program [gdb_find_readelf]
7069 # We're not testing readelf -d | grep "FLAGS_1.*Flags:.*PIE"
7070 # because the PIE flag is not set by all versions of gold, see PR
7072 set res [catch {exec $readelf_program -h $executable} output]
7076 set res [regexp -line {^[ \t]*Type:[ \t]*DYN \((Position-Independent Executable|Shared object) file\)$} \
7084 # Return false if a test should be skipped due to lack of floating
7085 # point support or GDB can't fetch the contents from floating point
7088 gdb_caching_proc allow_float_test {} {
7089 if [target_info exists gdb,skip_float_tests] {
7093 # There is an ARM kernel ptrace bug that hardware VFP registers
7094 # are not updated after GDB ptrace set VFP registers. The bug
7095 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
7096 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
7097 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
7098 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
7099 # This kernel bug is detected by check how does GDB change the
7100 # program result by changing one VFP register.
7101 if { [istarget "arm*-*-linux*"] } {
7103 set compile_flags {debug nowarnings }
7105 # Set up, compile, and execute a test program having VFP
7107 set src [standard_temp_file arm_vfp.c]
7108 set exe [standard_temp_file arm_vfp.x]
7110 gdb_produce_source $src {
7115 asm ("vldr d0, [%0]" : : "r" (&d));
7116 asm ("vldr d1, [%0]" : : "r" (&d));
7117 asm (".global break_here\n"
7119 asm ("vcmp.f64 d0, d1\n"
7120 "vmrs APSR_nzcv, fpscr\n"
7121 "bne L_value_different\n"
7124 "L_value_different:\n"
7126 "L_end:\n" : "=r" (ret) :);
7128 /* Return $d0 != $d1. */
7133 verbose "compiling testfile $src" 2
7134 set lines [gdb_compile $src $exe executable $compile_flags]
7137 if {![string match "" $lines]} {
7138 verbose "testfile compilation failed, returning 1" 2
7142 # No error message, compilation succeeded so now run it via gdb.
7143 # Run the test up to 5 times to detect whether ptrace can
7144 # correctly update VFP registers or not.
7145 set allow_vfp_test 1
7146 for {set i 0} {$i < 5} {incr i} {
7147 global gdb_prompt srcdir subdir
7151 gdb_reinitialize_dir $srcdir/$subdir
7155 gdb_test "break *break_here"
7156 gdb_continue_to_breakpoint "break_here"
7158 # Modify $d0 to a different value, so the exit code should
7160 gdb_test "set \$d0 = 5.0"
7162 set test "continue to exit"
7163 gdb_test_multiple "continue" "$test" {
7164 -re "exited with code 01.*$gdb_prompt $" {
7166 -re "exited normally.*$gdb_prompt $" {
7167 # However, the exit code is 0. That means something
7168 # wrong in setting VFP registers.
7169 set allow_vfp_test 0
7176 remote_file build delete $exe
7178 return $allow_vfp_test
7183 # Print a message and return true if a test should be skipped
7184 # due to lack of stdio support.
7186 proc gdb_skip_stdio_test { msg } {
7187 if [target_info exists gdb,noinferiorio] {
7188 verbose "Skipping test '$msg': no inferior i/o."
7194 proc gdb_skip_bogus_test { msg } {
7198 # Return true if XML support is enabled in the host GDB.
7199 # NOTE: This must be called while gdb is *not* running.
7201 gdb_caching_proc allow_xml_test {} {
7206 if { [info exists gdb_spawn_id] } {
7207 error "GDB must not be running in allow_xml_tests."
7210 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
7214 gdb_test_multiple "set tdesc filename $xml_file" "" {
7215 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
7218 -re ".*$gdb_prompt $" { }
7221 return [expr {!$xml_missing}]
7224 # Return true if argv[0] is available.
7226 gdb_caching_proc gdb_has_argv0 {} {
7229 # Compile and execute a test program to check whether argv[0] is available.
7230 gdb_simple_compile has_argv0 {
7231 int main (int argc, char **argv) {
7238 proc gdb_has_argv0_1 { exe } {
7239 global srcdir subdir
7240 global gdb_prompt hex
7244 gdb_reinitialize_dir $srcdir/$subdir
7247 # Set breakpoint on main.
7248 gdb_test_multiple "break -q main" "break -q main" {
7249 -re "Breakpoint.*${gdb_prompt} $" {
7251 -re "${gdb_prompt} $" {
7258 gdb_test_multiple "" "run to main" {
7259 -re "Breakpoint.*${gdb_prompt} $" {
7261 -re "${gdb_prompt} $" {
7266 set old_elements "200"
7267 set test "show print elements"
7268 gdb_test_multiple $test $test {
7269 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
7270 set old_elements $expect_out(1,string)
7273 set old_repeats "200"
7274 set test "show print repeats"
7275 gdb_test_multiple $test $test {
7276 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
7277 set old_repeats $expect_out(1,string)
7280 gdb_test_no_output "set print elements unlimited" ""
7281 gdb_test_no_output "set print repeats unlimited" ""
7284 # Check whether argc is 1.
7285 gdb_test_multiple "p argc" "p argc" {
7286 -re " = 1\r\n${gdb_prompt} $" {
7288 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
7289 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
7292 -re "${gdb_prompt} $" {
7296 -re "${gdb_prompt} $" {
7300 gdb_test_no_output "set print elements $old_elements" ""
7301 gdb_test_no_output "set print repeats $old_repeats" ""
7306 set result [gdb_has_argv0_1 $obj]
7312 && ([istarget *-*-linux*]
7313 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
7314 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
7315 || [istarget *-*-openbsd*]
7316 || [istarget *-*-darwin*]
7317 || [istarget *-*-solaris*]
7318 || [istarget *-*-aix*]
7319 || [istarget *-*-gnu*]
7320 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
7321 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
7322 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
7323 || [istarget *-*-osf*]
7324 || [istarget *-*-dicos*]
7325 || [istarget *-*-nto*]
7326 || [istarget *-*-*vms*]
7327 || [istarget *-*-lynx*178]) } {
7328 fail "argv\[0\] should be available on this target"
7334 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
7335 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
7336 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
7337 # the name of a debuginfo only file. This file will be stored in the same
7340 # Functions for separate debug info testing
7342 # starting with an executable:
7343 # foo --> original executable
7345 # at the end of the process we have:
7346 # foo.stripped --> foo w/o debug info
7347 # foo.debug --> foo's debug info
7348 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
7350 # Fetch the build id from the file.
7351 # Returns "" if there is none.
7353 proc get_build_id { filename } {
7354 if { ([istarget "*-*-mingw*"]
7355 || [istarget *-*-cygwin*]) } {
7356 set objdump_program [gdb_find_objdump]
7357 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
7358 verbose "result is $result"
7359 verbose "output is $output"
7365 set tmp [standard_output_file "${filename}-tmp"]
7366 set objcopy_program [gdb_find_objcopy]
7367 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
7368 verbose "result is $result"
7369 verbose "output is $output"
7374 fconfigure $fi -translation binary
7375 # Skip the NOTE header.
7380 if {![string compare $data ""]} {
7383 # Convert it to hex.
7384 binary scan $data H* data
7389 # Return the build-id hex string (usually 160 bits as 40 hex characters)
7390 # converted to the form: .build-id/ab/cdef1234...89.debug
7391 # Return "" if no build-id found.
7392 proc build_id_debug_filename_get { filename } {
7393 set data [get_build_id $filename]
7394 if { $data == "" } {
7397 regsub {^..} $data {\0/} data
7398 return ".build-id/${data}.debug"
7401 # DEST should be a file compiled with debug information. This proc
7402 # creates two new files DEST.debug which contains the debug
7403 # information extracted from DEST, and DEST.stripped, which is a copy
7404 # of DEST with the debug information removed. A '.gnu_debuglink'
7405 # section will be added to DEST.stripped that points to DEST.debug.
7407 # If ARGS is passed, it is a list of optional flags. The currently
7408 # supported flags are:
7410 # - no-main : remove the symbol entry for main from the separate
7411 # debug file DEST.debug,
7412 # - no-debuglink : don't add the '.gnu_debuglink' section to
7415 # Function returns zero on success. Function will return non-zero failure code
7416 # on some targets not supporting separate debug info (such as i386-msdos).
7418 proc gdb_gnu_strip_debug { dest args } {
7420 # Use the first separate debug info file location searched by GDB so the
7421 # run cannot be broken by some stale file searched with higher precedence.
7422 set debug_file "${dest}.debug"
7424 set strip_to_file_program [transform strip]
7425 set objcopy_program [gdb_find_objcopy]
7427 set debug_link [file tail $debug_file]
7428 set stripped_file "${dest}.stripped"
7430 # Get rid of the debug info, and store result in stripped_file
7431 # something like gdb/testsuite/gdb.base/blah.stripped.
7432 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
7433 verbose "result is $result"
7434 verbose "output is $output"
7439 # Workaround PR binutils/10802:
7440 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
7441 set perm [file attributes ${dest} -permissions]
7442 file attributes ${stripped_file} -permissions $perm
7444 # Get rid of everything but the debug info, and store result in debug_file
7445 # This will be in the .debug subdirectory, see above.
7446 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
7447 verbose "result is $result"
7448 verbose "output is $output"
7453 # If no-main is passed, strip the symbol for main from the separate
7454 # file. This is to simulate the behavior of elfutils's eu-strip, which
7455 # leaves the symtab in the original file only. There's no way to get
7456 # objcopy or strip to remove the symbol table without also removing the
7457 # debugging sections, so this is as close as we can get.
7458 if {[lsearch -exact $args "no-main"] != -1} {
7459 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
7460 verbose "result is $result"
7461 verbose "output is $output"
7465 file delete "${debug_file}"
7466 file rename "${debug_file}-tmp" "${debug_file}"
7469 # Unless the "no-debuglink" flag is passed, then link the two
7470 # previous output files together, adding the .gnu_debuglink
7471 # section to the stripped_file, containing a pointer to the
7472 # debug_file, save the new file in dest.
7473 if {[lsearch -exact $args "no-debuglink"] == -1} {
7474 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
7475 verbose "result is $result"
7476 verbose "output is $output"
7482 # Workaround PR binutils/10802:
7483 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
7484 set perm [file attributes ${stripped_file} -permissions]
7485 file attributes ${dest} -permissions $perm
7490 # Test the output of GDB_COMMAND matches the pattern obtained
7491 # by concatenating all elements of EXPECTED_LINES. This makes
7492 # it possible to split otherwise very long string into pieces.
7493 # If third argument TESTNAME is not empty, it's used as the name of the
7494 # test to be printed on pass/fail.
7495 proc help_test_raw { gdb_command expected_lines {testname {}} } {
7496 set expected_output [join $expected_lines ""]
7497 if {$testname != {}} {
7498 gdb_test "${gdb_command}" "${expected_output}" $testname
7502 gdb_test "${gdb_command}" "${expected_output}"
7505 # A regexp that matches the end of help CLASS|PREFIX_COMMAND
7506 set help_list_trailer {
7507 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
7508 "Type \"apropos -v word\" for full documentation of commands related to \"word\"\.[\r\n]+"
7509 "Command name abbreviations are allowed if unambiguous\."
7512 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
7513 # are regular expressions that should match the beginning of output,
7514 # before the list of commands in that class.
7515 # LIST_OF_COMMANDS are regular expressions that should match the
7516 # list of commands in that class. If empty, the command list will be
7517 # matched automatically. The presence of standard epilogue will be tested
7519 # If last argument TESTNAME is not empty, it's used as the name of the
7520 # test to be printed on pass/fail.
7521 # Notice that the '[' and ']' characters don't need to be escaped for strings
7522 # wrapped in {} braces.
7523 proc test_class_help { command_class expected_initial_lines {list_of_commands {}} {testname {}} } {
7524 global help_list_trailer
7525 if {[llength $list_of_commands]>0} {
7526 set l_list_of_commands {"List of commands:[\r\n]+[\r\n]+"}
7527 set l_list_of_commands [concat $l_list_of_commands $list_of_commands]
7528 set l_list_of_commands [concat $l_list_of_commands {"[\r\n]+[\r\n]+"}]
7530 set l_list_of_commands {"List of commands\:.*[\r\n]+"}
7533 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
7535 set l_entire_body [concat $expected_initial_lines $l_list_of_commands \
7536 $l_stock_body $help_list_trailer]
7538 help_test_raw "help ${command_class}" $l_entire_body $testname
7541 # Like test_class_help but specialised to test "help user-defined".
7542 proc test_user_defined_class_help { {list_of_commands {}} {testname {}} } {
7543 test_class_help "user-defined" {
7544 "User-defined commands\.[\r\n]+"
7545 "The commands in this class are those defined by the user\.[\r\n]+"
7546 "Use the \"define\" command to define a command\.[\r\n]+"
7547 } $list_of_commands $testname
7551 # COMMAND_LIST should have either one element -- command to test, or
7552 # two elements -- abbreviated command to test, and full command the first
7553 # element is abbreviation of.
7554 # The command must be a prefix command. EXPECTED_INITIAL_LINES
7555 # are regular expressions that should match the beginning of output,
7556 # before the list of subcommands. The presence of
7557 # subcommand list and standard epilogue will be tested automatically.
7558 proc test_prefix_command_help { command_list expected_initial_lines args } {
7559 global help_list_trailer
7560 set command [lindex $command_list 0]
7561 if {[llength $command_list]>1} {
7562 set full_command [lindex $command_list 1]
7564 set full_command $command
7566 # Use 'list' and not just {} because we want variables to
7567 # be expanded in this list.
7568 set l_stock_body [list\
7569 "List of $full_command subcommands\:.*\[\r\n\]+"\
7570 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"]
7571 set l_entire_body [concat $expected_initial_lines $l_stock_body $help_list_trailer]
7572 if {[llength $args]>0} {
7573 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
7575 help_test_raw "help ${command}" $l_entire_body
7579 # Build executable named EXECUTABLE from specifications that allow
7580 # different options to be passed to different sub-compilations.
7581 # TESTNAME is the name of the test; this is passed to 'untested' if
7583 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
7584 # contains the option "pthreads", then gdb_compile_pthreads is used.
7585 # ARGS is a flat list of source specifications, of the form:
7586 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
7587 # Each SOURCE is compiled to an object file using its OPTIONS,
7588 # using gdb_compile.
7589 # Returns 0 on success, -1 on failure.
7590 proc build_executable_from_specs {testname executable options args} {
7594 set binfile [standard_output_file $executable]
7596 set func gdb_compile
7597 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads|openmp)$}]
7598 if {$func_index != -1} {
7599 set func "${func}_[lindex $options $func_index]"
7602 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
7603 # parameter. They also requires $sources while gdb_compile and
7604 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
7605 if [string match gdb_compile_shlib* $func] {
7607 foreach {s local_options} $args {
7608 if {[regexp "^/" "$s"]} {
7609 lappend sources_path "$s"
7611 lappend sources_path "$srcdir/$subdir/$s"
7614 set ret [$func $sources_path "${binfile}" $options]
7615 } elseif {[lsearch -exact $options rust] != -1} {
7617 foreach {s local_options} $args {
7618 if {[regexp "^/" "$s"]} {
7619 lappend sources_path "$s"
7621 lappend sources_path "$srcdir/$subdir/$s"
7624 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
7628 foreach {s local_options} $args {
7629 if {![regexp "^/" "$s"]} {
7630 set s "$srcdir/$subdir/$s"
7632 if { [$func "${s}" "${binfile}${i}.o" object $local_options] != "" } {
7636 lappend objects "${binfile}${i}.o"
7639 set ret [$func $objects "${binfile}" executable $options]
7649 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
7650 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
7651 # to pass to untested, if something is wrong. OPTIONS are passed
7652 # to gdb_compile directly.
7653 proc build_executable { testname executable {sources ""} {options {debug}} } {
7654 if {[llength $sources]==0} {
7655 set sources ${executable}.c
7658 set arglist [list $testname $executable $options]
7659 foreach source $sources {
7660 lappend arglist $source $options
7663 return [eval build_executable_from_specs $arglist]
7666 # Starts fresh GDB binary and loads an optional executable into GDB.
7667 # Usage: clean_restart [EXECUTABLE]
7668 # EXECUTABLE is the basename of the binary.
7669 # Return -1 if starting gdb or loading the executable failed.
7671 proc clean_restart {{executable ""}} {
7679 # This is a clean restart, so reset error and warning count.
7684 # if { [gdb_start] == -1 } {
7687 # but gdb_start is a ${tool}_start proc, which doesn't have a defined
7688 # return value. So instead, we test for errcnt.
7690 if { $errcnt > 0 } {
7694 gdb_reinitialize_dir $srcdir/$subdir
7696 if {$executable != ""} {
7697 set binfile [standard_output_file ${executable}]
7698 return [gdb_load ${binfile}]
7704 # Prepares for testing by calling build_executable_full, then
7706 # TESTNAME is the name of the test.
7707 # Each element in ARGS is a list of the form
7708 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
7709 # These are passed to build_executable_from_specs, which see.
7710 # The last EXECUTABLE is passed to clean_restart.
7711 # Returns 0 on success, non-zero on failure.
7712 proc prepare_for_testing_full {testname args} {
7713 foreach spec $args {
7714 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
7717 set executable [lindex $spec 0]
7719 clean_restart $executable
7723 # Prepares for testing, by calling build_executable, and then clean_restart.
7724 # Please refer to build_executable for parameter description.
7725 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
7727 if {[build_executable $testname $executable $sources $options] == -1} {
7730 clean_restart $executable
7735 # Retrieve the value of EXP in the inferior, represented in format
7736 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
7737 # print fails. TEST is the test message to use. It can be omitted,
7738 # in which case a test message is built from EXP.
7740 proc get_valueof { fmt exp default {test ""} } {
7744 set test "get valueof \"${exp}\""
7748 gdb_test_multiple "print${fmt} ${exp}" "$test" {
7749 -re "\\$\[0-9\]* = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
7750 set val $expect_out(1,string)
7754 fail "$test (timeout)"
7760 # Retrieve the value of local var EXP in the inferior. DEFAULT is used as
7761 # fallback if print fails. TEST is the test message to use. It can be
7762 # omitted, in which case a test message is built from EXP.
7764 proc get_local_valueof { exp default {test ""} } {
7768 set test "get local valueof \"${exp}\""
7772 gdb_test_multiple "info locals ${exp}" "$test" {
7773 -re "$exp = (\[^\r\n\]*)\[\r\n\]*$gdb_prompt $" {
7774 set val $expect_out(1,string)
7778 fail "$test (timeout)"
7784 # Retrieve the value of EXP in the inferior, as a signed decimal value
7785 # (using "print /d"). DEFAULT is used as fallback if print fails.
7786 # TEST is the test message to use. It can be omitted, in which case
7787 # a test message is built from EXP.
7789 proc get_integer_valueof { exp default {test ""} } {
7793 set test "get integer valueof \"${exp}\""
7797 gdb_test_multiple "print /d ${exp}" "$test" {
7798 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
7799 set val $expect_out(1,string)
7803 fail "$test (timeout)"
7809 # Retrieve the value of EXP in the inferior, as an hexadecimal value
7810 # (using "print /x"). DEFAULT is used as fallback if print fails.
7811 # TEST is the test message to use. It can be omitted, in which case
7812 # a test message is built from EXP.
7814 proc get_hexadecimal_valueof { exp default {test ""} } {
7818 set test "get hexadecimal valueof \"${exp}\""
7822 gdb_test_multiple "print /x ${exp}" $test {
7823 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
7824 set val $expect_out(1,string)
7831 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
7832 # is used as fallback if print fails. TEST is the test message to use.
7833 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
7835 proc get_sizeof { type default {test ""} } {
7836 return [get_integer_valueof "sizeof (${type})" $default $test]
7839 proc get_target_charset { } {
7842 gdb_test_multiple "show target-charset" "" {
7843 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
7844 return $expect_out(1,string)
7846 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
7847 return $expect_out(1,string)
7851 # Pick a reasonable default.
7852 warning "Unable to read target-charset."
7856 # Get the address of VAR.
7858 proc get_var_address { var } {
7859 global gdb_prompt hex
7861 # Match output like:
7863 # $5 = (int (*)()) 0
7864 # $6 = (int (*)()) 0x24 <function_bar>
7866 gdb_test_multiple "print &${var}" "get address of ${var}" {
7867 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
7869 pass "get address of ${var}"
7870 if { $expect_out(1,string) == "0" } {
7873 return $expect_out(1,string)
7880 # Return the frame number for the currently selected frame
7881 proc get_current_frame_number {{test_name ""}} {
7884 if { $test_name == "" } {
7885 set test_name "get current frame number"
7888 gdb_test_multiple "frame" $test_name {
7889 -re "#(\[0-9\]+) .*$gdb_prompt $" {
7890 set frame_num $expect_out(1,string)
7896 # Get the current value for remotetimeout and return it.
7897 proc get_remotetimeout { } {
7901 gdb_test_multiple "show remotetimeout" "" {
7902 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
7903 return $expect_out(1,string)
7907 # Pick the default that gdb uses
7908 warning "Unable to read remotetimeout"
7912 # Set the remotetimeout to the specified timeout. Nothing is returned.
7913 proc set_remotetimeout { timeout } {
7916 gdb_test_multiple "set remotetimeout $timeout" "" {
7917 -re "$gdb_prompt $" {
7918 verbose "Set remotetimeout to $timeout\n"
7923 # Get the target's current endianness and return it.
7924 proc get_endianness { } {
7927 gdb_test_multiple "show endian" "determine endianness" {
7928 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
7930 return $expect_out(1,string)
7936 # Get the target's default endianness and return it.
7937 gdb_caching_proc target_endianness {} {
7940 set me "target_endianness"
7942 set src { int main() { return 0; } }
7943 if {![gdb_simple_compile $me $src executable]} {
7951 set res [get_endianness]
7954 remote_file build delete $obj
7959 # ROOT and FULL are file names. Returns the relative path from ROOT
7960 # to FULL. Note that FULL must be in a subdirectory of ROOT.
7961 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
7964 proc relative_filename {root full} {
7965 set root_split [file split $root]
7966 set full_split [file split $full]
7968 set len [llength $root_split]
7970 if {[eval file join $root_split]
7971 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
7972 error "$full not a subdir of $root"
7975 return [eval file join [lrange $full_split $len end]]
7978 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
7979 if {[info exists GDB_PARALLEL]} {
7980 if {[is_remote host]} {
7984 [make_gdb_parallel_path outputs] \
7985 [make_gdb_parallel_path temp] \
7986 [make_gdb_parallel_path cache]
7990 # Set the inferior's cwd to the output directory, in order to have it
7991 # dump core there. This must be called before the inferior is
7994 proc set_inferior_cwd_to_output_dir {} {
7995 # Note this sets the inferior's cwd ("set cwd"), not GDB's ("cd").
7996 # If GDB crashes, we want its core dump in gdb/testsuite/, not in
7997 # the testcase's dir, so we can detect the unexpected core at the
7998 # end of the test run.
7999 if {![is_remote host]} {
8000 set output_dir [standard_output_file ""]
8001 gdb_test_no_output "set cwd $output_dir" \
8002 "set inferior cwd to test directory"
8006 # Get the inferior's PID.
8008 proc get_inferior_pid {} {
8010 gdb_test_multiple "inferior" "get inferior pid" {
8011 -re "process (\[0-9\]*).*$::gdb_prompt $" {
8012 set pid $expect_out(1,string)
8019 # Find the kernel-produced core file dumped for the current testfile
8020 # program. PID was the inferior's pid, saved before the inferior
8021 # exited with a signal, or -1 if not known. If not on a remote host,
8022 # this assumes the core was generated in the output directory.
8023 # Returns the name of the core dump, or empty string if not found.
8025 proc find_core_file {pid} {
8026 # For non-remote hosts, since cores are assumed to be in the
8027 # output dir, which we control, we use a laxer "core.*" glob. For
8028 # remote hosts, as we don't know whether the dir is being reused
8029 # for parallel runs, we use stricter names with no globs. It is
8030 # not clear whether this is really important, but it preserves
8033 if {![is_remote host]} {
8034 lappend files core.*
8035 } elseif {$pid != -1} {
8036 lappend files core.$pid
8038 lappend files ${::testfile}.core
8041 foreach file $files {
8042 if {![is_remote host]} {
8043 set names [glob -nocomplain [standard_output_file $file]]
8044 if {[llength $names] == 1} {
8045 return [lindex $names 0]
8048 if {[remote_file host exists $file]} {
8056 # Check for production of a core file and remove it. PID is the
8057 # inferior's pid or -1 if not known. TEST is the test's message.
8059 proc remove_core {pid {test ""}} {
8061 set test "cleanup core file"
8064 set file [find_core_file $pid]
8066 remote_file host delete $file
8067 pass "$test (removed)"
8069 pass "$test (not found)"
8073 proc core_find {binfile {deletefiles {}} {arg ""}} {
8074 global objdir subdir
8076 set destcore "$binfile.core"
8077 file delete $destcore
8079 # Create a core file named "$destcore" rather than just "core", to
8080 # avoid problems with sys admin types that like to regularly prune all
8081 # files named "core" from the system.
8083 # Arbitrarily try setting the core size limit to "unlimited" since
8084 # this does not hurt on systems where the command does not work and
8085 # allows us to generate a core on systems where it does.
8087 # Some systems append "core" to the name of the program; others append
8088 # the name of the program to "core"; still others (like Linux, as of
8089 # May 2003) create cores named "core.PID". In the latter case, we
8090 # could have many core files lying around, and it may be difficult to
8091 # tell which one is ours, so let's run the program in a subdirectory.
8093 set coredir [standard_output_file coredir.[getpid]]
8095 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
8096 # remote_exec host "${binfile}"
8097 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
8098 if [remote_file build exists $i] {
8099 remote_exec build "mv $i $destcore"
8103 # Check for "core.PID", "core.EXEC.PID.HOST.TIME", etc. It's fine
8104 # to use a glob here as we're looking inside a directory we
8105 # created. Also, this procedure only works on non-remote hosts.
8106 if { $found == 0 } {
8107 set names [glob -nocomplain -directory $coredir core.*]
8108 if {[llength $names] == 1} {
8109 set corefile [file join $coredir [lindex $names 0]]
8110 remote_exec build "mv $corefile $destcore"
8114 if { $found == 0 } {
8115 # The braindamaged HPUX shell quits after the ulimit -c above
8116 # without executing ${binfile}. So we try again without the
8117 # ulimit here if we didn't find a core file above.
8118 # Oh, I should mention that any "braindamaged" non-Unix system has
8119 # the same problem. I like the cd bit too, it's really neat'n stuff.
8120 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
8121 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
8122 if [remote_file build exists $i] {
8123 remote_exec build "mv $i $destcore"
8129 # Try to clean up after ourselves.
8130 foreach deletefile $deletefiles {
8131 remote_file build delete [file join $coredir $deletefile]
8133 remote_exec build "rmdir $coredir"
8135 if { $found == 0 } {
8136 warning "can't generate a core file - core tests suppressed - check ulimit -c"
8142 # gdb_target_symbol_prefix compiles a test program and then examines
8143 # the output from objdump to determine the prefix (such as underscore)
8144 # for linker symbol prefixes.
8146 gdb_caching_proc gdb_target_symbol_prefix {} {
8147 # Compile a simple test program...
8148 set src { int main() { return 0; } }
8149 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
8155 set objdump_program [gdb_find_objdump]
8156 set result [catch "exec $objdump_program --syms $obj" output]
8159 && ![regexp -lineanchor \
8160 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
8161 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
8169 # Return 1 if target supports scheduler locking, otherwise return 0.
8171 gdb_caching_proc target_supports_scheduler_locking {} {
8174 set me "gdb_target_supports_scheduler_locking"
8176 set src { int main() { return 0; } }
8177 if {![gdb_simple_compile $me $src executable]} {
8186 set supports_schedule_locking -1
8187 set current_schedule_locking_mode ""
8189 set test "reading current scheduler-locking mode"
8190 gdb_test_multiple "show scheduler-locking" $test {
8191 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
8192 set current_schedule_locking_mode $expect_out(1,string)
8194 -re "$gdb_prompt $" {
8195 set supports_schedule_locking 0
8198 set supports_schedule_locking 0
8202 if { $supports_schedule_locking == -1 } {
8203 set test "checking for scheduler-locking support"
8204 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
8205 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
8206 set supports_schedule_locking 0
8208 -re "$gdb_prompt $" {
8209 set supports_schedule_locking 1
8212 set supports_schedule_locking 0
8217 if { $supports_schedule_locking == -1 } {
8218 set supports_schedule_locking 0
8222 remote_file build delete $obj
8223 verbose "$me: returning $supports_schedule_locking" 2
8224 return $supports_schedule_locking
8227 # Return 1 if compiler supports use of nested functions. Otherwise,
8230 gdb_caching_proc support_nested_function_tests {} {
8231 # Compile a test program containing a nested function
8232 return [gdb_can_simple_compile nested_func {
8242 # gdb_target_symbol returns the provided symbol with the correct prefix
8243 # prepended. (See gdb_target_symbol_prefix, above.)
8245 proc gdb_target_symbol { symbol } {
8246 set prefix [gdb_target_symbol_prefix]
8247 return "${prefix}${symbol}"
8250 # gdb_target_symbol_prefix_flags_asm returns a string that can be
8251 # added to gdb_compile options to define the C-preprocessor macro
8252 # SYMBOL_PREFIX with a value that can be prepended to symbols
8253 # for targets which require a prefix, such as underscore.
8255 # This version (_asm) defines the prefix without double quotes
8256 # surrounding the prefix. It is used to define the macro
8257 # SYMBOL_PREFIX for assembly language files. Another version, below,
8258 # is used for symbols in inline assembler in C/C++ files.
8260 # The lack of quotes in this version (_asm) makes it possible to
8261 # define supporting macros in the .S file. (The version which
8262 # uses quotes for the prefix won't work for such files since it's
8263 # impossible to define a quote-stripping macro in C.)
8265 # It's possible to use this version (_asm) for C/C++ source files too,
8266 # but a string is usually required in such files; providing a version
8267 # (no _asm) which encloses the prefix with double quotes makes it
8268 # somewhat easier to define the supporting macros in the test case.
8270 proc gdb_target_symbol_prefix_flags_asm {} {
8271 set prefix [gdb_target_symbol_prefix]
8272 if {$prefix ne ""} {
8273 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
8279 # gdb_target_symbol_prefix_flags returns the same string as
8280 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
8281 # enclosed in double quotes if there is a prefix.
8283 # See the comment for gdb_target_symbol_prefix_flags_asm for an
8284 # extended discussion.
8286 proc gdb_target_symbol_prefix_flags {} {
8287 set prefix [gdb_target_symbol_prefix]
8288 if {$prefix ne ""} {
8289 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
8295 # A wrapper for 'remote_exec host' that passes or fails a test.
8296 # Returns 0 if all went well, nonzero on failure.
8297 # TEST is the name of the test, other arguments are as for remote_exec.
8299 proc run_on_host { test program args } {
8300 verbose -log "run_on_host: $program $args"
8301 # remote_exec doesn't work properly if the output is set but the
8302 # input is the empty string -- so replace an empty input with
8304 if {[llength $args] > 1 && [lindex $args 1] == ""} {
8305 set args [lreplace $args 1 1 "/dev/null"]
8307 set result [eval remote_exec host [list $program] $args]
8308 verbose "result is $result"
8309 set status [lindex $result 0]
8310 set output [lindex $result 1]
8315 verbose -log "run_on_host failed: $output"
8316 if { $output == "spawn failed" } {
8325 # Return non-zero if "board_info debug_flags" mentions Fission.
8326 # http://gcc.gnu.org/wiki/DebugFission
8327 # Fission doesn't support everything yet.
8328 # This supports working around bug 15954.
8330 proc using_fission { } {
8331 set debug_flags [board_info [target_info name] debug_flags]
8332 return [regexp -- "-gsplit-dwarf" $debug_flags]
8335 # Search LISTNAME in uplevel LEVEL caller and set variables according to the
8336 # list of valid options with prefix PREFIX described by ARGSET.
8338 # The first member of each one- or two-element list in ARGSET defines the
8339 # name of a variable that will be added to the caller's scope.
8341 # If only one element is given to describe an option, it the value is
8342 # 0 if the option is not present in (the caller's) ARGS or 1 if
8345 # If two elements are given, the second element is the default value of
8346 # the variable. This is then overwritten if the option exists in ARGS.
8347 # If EVAL, then subst is called on the value, which allows variables
8350 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
8351 # any optional components.
8354 # proc myproc {foo args} {
8355 # parse_list args 1 {{bar} {baz "abc"} {qux}} "-" false
8358 # myproc ABC -bar -baz DEF peanut butter
8359 # will define the following variables in myproc:
8360 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
8361 # args will be the list {peanut butter}
8363 proc parse_list { level listname argset prefix eval } {
8364 upvar $level $listname args
8366 foreach argument $argset {
8367 if {[llength $argument] == 1} {
8368 # Normalize argument, strip leading/trailing whitespace.
8369 # Allows us to treat {foo} and { foo } the same.
8370 set argument [string trim $argument]
8372 # No default specified, so we assume that we should set
8373 # the value to 1 if the arg is present and 0 if it's not.
8374 # It is assumed that no value is given with the argument.
8375 set pattern "$prefix$argument"
8376 set result [lsearch -exact $args $pattern]
8378 if {$result != -1} {
8380 set args [lreplace $args $result $result]
8384 uplevel $level [list set $argument $value]
8385 } elseif {[llength $argument] == 2} {
8386 # There are two items in the argument. The second is a
8387 # default value to use if the item is not present.
8388 # Otherwise, the variable is set to whatever is provided
8389 # after the item in the args.
8390 set arg [lindex $argument 0]
8391 set pattern "$prefix[lindex $arg 0]"
8392 set result [lsearch -exact $args $pattern]
8394 if {$result != -1} {
8395 set value [lindex $args [expr $result+1]]
8397 set value [uplevel [expr $level + 1] [list subst $value]]
8399 set args [lreplace $args $result [expr $result+1]]
8401 set value [lindex $argument 1]
8403 set value [uplevel $level [list subst $value]]
8406 uplevel $level [list set $arg $value]
8408 error "Badly formatted argument \"$argument\" in argument set"
8413 # Search the caller's args variable and set variables according to the list of
8414 # valid options described by ARGSET.
8416 proc parse_args { argset } {
8417 parse_list 2 args $argset "-" false
8419 # The remaining args should be checked to see that they match the
8420 # number of items expected to be passed into the procedure...
8423 # Process the caller's options variable and set variables according
8424 # to the list of valid options described by OPTIONSET.
8426 proc parse_options { optionset } {
8427 parse_list 2 options $optionset "" true
8429 # Require no remaining options.
8430 upvar 1 options options
8431 if { [llength $options] != 0 } {
8432 error "Options left unparsed: $options"
8436 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
8437 # return that string.
8439 proc capture_command_output { command prefix } {
8443 set test "capture_command_output for $command"
8445 set output_string ""
8446 gdb_test_multiple $command $test {
8447 -re "^(\[^\r\n\]+\r\n)" {
8448 if { ![string equal $output_string ""] } {
8449 set output_string [join [list $output_string $expect_out(1,string)] ""]
8451 set output_string $expect_out(1,string)
8456 -re "^$gdb_prompt $" {
8460 # Strip the command.
8461 set command_re [string_to_regexp ${command}]
8462 set output_string [regsub ^$command_re\r\n $output_string ""]
8465 if { $prefix != "" } {
8466 set output_string [regsub ^$prefix $output_string ""]
8469 # Strip a trailing newline.
8470 set output_string [regsub "\r\n$" $output_string ""]
8472 return $output_string
8475 # A convenience function that joins all the arguments together, with a
8476 # regexp that matches exactly one end of line in between each argument.
8477 # This function is ideal to write the expected output of a GDB command
8478 # that generates more than a couple of lines, as this allows us to write
8479 # each line as a separate string, which is easier to read by a human
8482 proc multi_line { args } {
8483 if { [llength $args] == 1 } {
8484 set hint "forgot {*} before list argument?"
8485 error "multi_line called with one argument ($hint)"
8487 return [join $args "\r\n"]
8490 # Similar to the above, but while multi_line is meant to be used to
8491 # match GDB output, this one is meant to be used to build strings to
8492 # send as GDB input.
8494 proc multi_line_input { args } {
8495 return [join $args "\n"]
8498 # Return how many newlines there are in the given string.
8500 proc count_newlines { string } {
8501 return [regexp -all "\n" $string]
8504 # Return the version of the DejaGnu framework.
8506 # The return value is a list containing the major, minor and patch version
8507 # numbers. If the version does not contain a minor or patch number, they will
8508 # be set to 0. For example:
8514 proc dejagnu_version { } {
8515 # The frame_version variable is defined by DejaGnu, in runtest.exp.
8516 global frame_version
8518 verbose -log "DejaGnu version: $frame_version"
8519 verbose -log "Expect version: [exp_version]"
8520 verbose -log "Tcl version: [info tclversion]"
8522 set dg_ver [split $frame_version .]
8524 while { [llength $dg_ver] < 3 } {
8531 # Define user-defined command COMMAND using the COMMAND_LIST as the
8532 # command's definition. The terminating "end" is added automatically.
8534 proc gdb_define_cmd {command command_list} {
8537 set input [multi_line_input {*}$command_list "end"]
8538 set test "define $command"
8540 gdb_test_multiple "define $command" $test {
8541 -re "End with \[^\r\n\]*\r\n *>$" {
8542 gdb_test_multiple $input $test {
8543 -re "\r\n$gdb_prompt " {
8550 # Override the 'cd' builtin with a version that ensures that the
8551 # log file keeps pointing at the same file. We need this because
8552 # unfortunately the path to the log file is recorded using an
8553 # relative path name, and, we sometimes need to close/reopen the log
8554 # after changing the current directory. See get_compiler_info.
8556 rename cd builtin_cd
8560 # Get the existing log file flags.
8561 set log_file_info [log_file -info]
8563 # Split the flags into args and file name.
8564 set log_file_flags ""
8565 set log_file_file ""
8566 foreach arg [ split "$log_file_info" " "] {
8567 if [string match "-*" $arg] {
8568 lappend log_file_flags $arg
8570 lappend log_file_file $arg
8574 # If there was an existing file, ensure it is an absolute path, and then
8576 if { $log_file_file != "" } {
8577 set log_file_file [file normalize $log_file_file]
8579 log_file $log_file_flags "$log_file_file"
8582 # Call the builtin version of cd.
8586 # Return a list of all languages supported by GDB, suitable for use in
8587 # 'set language NAME'. This doesn't include either the 'local' or
8589 proc gdb_supported_languages {} {
8590 return [list c objective-c c++ d go fortran modula-2 asm pascal \
8591 opencl rust minimal ada]
8594 # Check if debugging is enabled for gdb.
8596 proc gdb_debug_enabled { } {
8599 # If not already read, get the debug setting from environment or board setting.
8600 if {![info exists gdbdebug]} {
8602 if [info exists env(GDB_DEBUG)] {
8603 set gdbdebug $env(GDB_DEBUG)
8604 } elseif [target_info exists gdb,debug] {
8605 set gdbdebug [target_info gdb,debug]
8611 # Ensure it not empty.
8612 return [expr { $gdbdebug != "" }]
8615 # Turn on debugging if enabled, or reset if already on.
8617 proc gdb_debug_init { } {
8621 if ![gdb_debug_enabled] {
8625 # First ensure logging is off.
8626 send_gdb "set logging enabled off\n"
8628 set debugfile [standard_output_file gdb.debug]
8629 send_gdb "set logging file $debugfile\n"
8631 send_gdb "set logging debugredirect\n"
8634 foreach entry [split $gdbdebug ,] {
8635 send_gdb "set debug $entry 1\n"
8638 # Now that everything is set, enable logging.
8639 send_gdb "set logging enabled on\n"
8641 -re "Copying output to $debugfile.*Redirecting debug output to $debugfile.*$gdb_prompt $" {}
8642 timeout { warning "Couldn't set logging file" }
8646 # Check if debugging is enabled for gdbserver.
8648 proc gdbserver_debug_enabled { } {
8649 # Always disabled for GDB only setups.
8653 # Open the file for logging gdb input
8655 proc gdb_stdin_log_init { } {
8656 gdb_persistent_global in_file
8658 if {[info exists in_file]} {
8659 # Close existing file.
8660 catch "close $in_file"
8663 set logfile [standard_output_file_with_gdb_instance gdb.in]
8664 set in_file [open $logfile w]
8667 # Write to the file for logging gdb input.
8668 # TYPE can be one of the following:
8669 # "standard" : Default. Standard message written to the log
8670 # "answer" : Answer to a question (eg "Y"). Not written the log.
8671 # "optional" : Optional message. Not written to the log.
8673 proc gdb_stdin_log_write { message {type standard} } {
8676 if {![info exists in_file]} {
8680 # Check message types.
8681 switch -regexp -- $type {
8690 # Write to the log and make sure the output is there, even in case
8692 puts -nonewline $in_file "$message"
8696 # Write the command line used to invocate gdb to the cmd file.
8698 proc gdb_write_cmd_file { cmdline } {
8699 set logfile [standard_output_file_with_gdb_instance gdb.cmd]
8700 set cmd_file [open $logfile w]
8701 puts $cmd_file $cmdline
8702 catch "close $cmd_file"
8705 # Compare contents of FILE to string STR. Pass with MSG if equal, otherwise
8708 proc cmp_file_string { file str msg } {
8709 if { ![file exists $file]} {
8714 set caught_error [catch {
8715 set fp [open "$file" r]
8716 set file_contents [read $fp]
8719 if {$caught_error} {
8720 error "$error_message"
8725 if { $file_contents == $str } {
8732 # Compare FILE1 and FILE2 as binary files. Return 0 if the files are
8733 # equal, otherwise, return non-zero.
8735 proc cmp_binary_files { file1 file2 } {
8736 set fd1 [open $file1]
8737 fconfigure $fd1 -translation binary
8738 set fd2 [open $file2]
8739 fconfigure $fd2 -translation binary
8743 set blk1 [read $fd1 $blk_size]
8744 set blk2 [read $fd2 $blk_size]
8745 set diff [string compare $blk1 $blk2]
8746 if {$diff != 0 || [eof $fd1] || [eof $fd2]} {
8754 # Does the compiler support CTF debug output using '-gctf' compiler
8755 # flag? If not then we should skip these tests. We should also
8756 # skip them if libctf was explicitly disabled.
8758 gdb_caching_proc allow_ctf_tests {} {
8759 global enable_libctf
8761 if {$enable_libctf eq "no"} {
8765 set can_ctf [gdb_can_simple_compile ctfdebug {
8769 } executable "additional_flags=-gctf"]
8774 # Return 1 if compiler supports -gstatement-frontiers. Otherwise,
8777 gdb_caching_proc supports_statement_frontiers {} {
8778 return [gdb_can_simple_compile supports_statement_frontiers {
8782 } executable "additional_flags=-gstatement-frontiers"]
8785 # Return 1 if compiler supports -mmpx -fcheck-pointer-bounds. Otherwise,
8788 gdb_caching_proc supports_mpx_check_pointer_bounds {} {
8789 set flags "additional_flags=-mmpx additional_flags=-fcheck-pointer-bounds"
8790 return [gdb_can_simple_compile supports_mpx_check_pointer_bounds {
8794 } executable $flags]
8797 # Return 1 if compiler supports -fcf-protection=. Otherwise,
8800 gdb_caching_proc supports_fcf_protection {} {
8801 return [gdb_can_simple_compile supports_fcf_protection {
8805 } executable "additional_flags=-fcf-protection=full"]
8808 # Return true if symbols were read in using -readnow. Otherwise,
8812 return [expr {[lsearch -exact $::GDBFLAGS -readnow] != -1
8813 || [lsearch -exact $::GDBFLAGS --readnow] != -1}]
8816 # Return index name if symbols were read in using an index.
8817 # Otherwise, return "".
8819 proc have_index { objfile } {
8820 # This proc is mostly used with $binfile, but that gives problems with
8821 # remote host, while using $testfile would work.
8822 # Fix this by reducing $binfile to $testfile.
8823 set objfile [file tail $objfile]
8826 set cmd "maint print objfiles $objfile"
8827 gdb_test_multiple $cmd "" -lbl {
8828 -re "\r\n.gdb_index: faked for \"readnow\"" {
8832 -re "\r\n.gdb_index:" {
8836 -re "\r\n.debug_names:" {
8837 set res "debug_names"
8841 # We don't care about any other input.
8848 # Return 1 if partial symbols are available. Otherwise, return 0.
8850 proc psymtabs_p { } {
8853 set cmd "maint info psymtab"
8854 gdb_test_multiple $cmd "" {
8855 -re "$cmd\r\n$gdb_prompt $" {
8866 # Verify that partial symtab expansion for $filename has state $readin.
8868 proc verify_psymtab_expanded { filename readin } {
8871 set cmd "maint info psymtab"
8872 set test "$cmd: $filename: $readin"
8873 set re [multi_line \
8874 " \{ psymtab \[^\r\n\]*$filename\[^\r\n\]*" \
8878 gdb_test_multiple $cmd $test {
8879 -re "$cmd\r\n$gdb_prompt $" {
8880 unsupported $gdb_test_name
8888 # Add a .gdb_index section to PROGRAM.
8889 # PROGRAM is assumed to be the output of standard_output_file.
8890 # Returns the 0 if there is a failure, otherwise 1.
8892 # STYLE controls which style of index to add, if needed. The empty
8893 # string (the default) means .gdb_index; "-dwarf-5" means .debug_names.
8895 proc add_gdb_index { program {style ""} } {
8896 global srcdir GDB env
8897 set contrib_dir "$srcdir/../contrib"
8898 set env(GDB) [append_gdb_data_directory_option $GDB]
8899 set result [catch "exec $contrib_dir/gdb-add-index.sh $style $program" output]
8900 if { $result != 0 } {
8901 verbose -log "result is $result"
8902 verbose -log "output is $output"
8909 # Add a .gdb_index section to PROGRAM, unless it alread has an index
8910 # (.gdb_index/.debug_names). Gdb doesn't support building an index from a
8911 # program already using one. Return 1 if a .gdb_index was added, return 0
8912 # if it already contained an index, and -1 if an error occurred.
8914 # STYLE controls which style of index to add, if needed. The empty
8915 # string (the default) means .gdb_index; "-dwarf-5" means .debug_names.
8917 proc ensure_gdb_index { binfile {style ""} } {
8920 set testfile [file tail $binfile]
8921 set test "check if index present"
8924 gdb_test_multiple "mt print objfiles ${testfile}" $test -lbl {
8925 -re "\r\n\\.gdb_index: version ${decimal}(?=\r\n)" {
8927 gdb_test_lines "" $gdb_test_name ".*"
8929 -re "\r\n\\.debug_names: exists(?=\r\n)" {
8931 gdb_test_lines "" $gdb_test_name ".*"
8933 -re "\r\n(Cooked index in use:|Psymtabs)(?=\r\n)" {
8934 gdb_test_lines "" $gdb_test_name ".*"
8936 -re ".gdb_index: faked for \"readnow\"" {
8938 gdb_test_lines "" $gdb_test_name ".*"
8949 if { $has_readnow } {
8953 if { [add_gdb_index $binfile $style] == "1" } {
8960 # Return 1 if executable contains .debug_types section. Otherwise, return 0.
8962 proc debug_types { } {
8965 set cmd "maint info sections"
8966 gdb_test_multiple $cmd "" {
8967 -re -wrap "at $hex: .debug_types.*" {
8978 # Return the addresses in the line table for FILE for which is_stmt is true.
8980 proc is_stmt_addresses { file } {
8986 gdb_test_multiple "maint info line-table $file" "" {
8987 -re "\r\n$decimal\[ \t\]+$decimal\[ \t\]+($hex)\[ \t\]+$hex\[ \t\]+Y\[^\r\n\]*" {
8988 lappend is_stmt $expect_out(1,string)
8998 # Return 1 if hex number VAL is an element of HEXLIST.
9000 proc hex_in_list { val hexlist } {
9001 # Normalize val by removing 0x prefix, and leading zeros.
9002 set val [regsub ^0x $val ""]
9003 set val [regsub ^0+ $val "0"]
9006 set index [lsearch -regexp $hexlist $re]
9007 return [expr $index != -1]
9010 # Override proc NAME to proc OVERRIDE for the duration of the execution of
9013 proc with_override { name override body } {
9014 # Implementation note: It's possible to implement the override using
9015 # rename, like this:
9016 # rename $name save_$name
9017 # rename $override $name
9018 # set code [catch {uplevel 1 $body} result]
9019 # rename $name $override
9020 # rename save_$name $name
9021 # but there are two issues here:
9022 # - the save_$name might clash with an existing proc
9023 # - the override is no longer available under its original name during
9025 # So, we use this more elaborate but cleaner mechanism.
9027 # Save the old proc, if it exists.
9028 if { [info procs $name] != "" } {
9029 set old_args [info args $name]
9030 set old_body [info body $name]
9036 # Install the override.
9037 set new_args [info args $override]
9038 set new_body [info body $override]
9039 eval proc $name {$new_args} {$new_body}
9042 set code [catch {uplevel 1 $body} result]
9044 # Restore old proc if it existed on entry, else delete it.
9046 eval proc $name {$old_args} {$old_body}
9051 # Return as appropriate.
9053 global errorInfo errorCode
9054 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
9055 } elseif { $code > 1 } {
9056 return -code $code $result
9062 # Setup tuiterm.exp environment. To be used in test-cases instead of
9063 # "load_lib tuiterm.exp". Calls initialization function and schedules
9064 # finalization function.
9065 proc tuiterm_env { } {
9066 load_lib tuiterm.exp
9069 # Dejagnu has a version of note, but usage is not allowed outside of dejagnu.
9070 # Define a local version.
9071 proc gdb_note { message } {
9072 verbose -- "NOTE: $message" 0
9075 # Return 1 if compiler supports -fuse-ld=gold, otherwise return 0.
9076 gdb_caching_proc have_fuse_ld_gold {} {
9077 set me "have_fuse_ld_gold"
9078 set flags "additional_flags=-fuse-ld=gold"
9079 set src { int main() { return 0; } }
9080 return [gdb_simple_compile $me $src executable $flags]
9083 # Return 1 if compiler supports fvar-tracking, otherwise return 0.
9084 gdb_caching_proc have_fvar_tracking {} {
9085 set me "have_fvar_tracking"
9086 set flags "additional_flags=-fvar-tracking"
9087 set src { int main() { return 0; } }
9088 return [gdb_simple_compile $me $src executable $flags]
9091 # Return 1 if linker supports -Ttext-segment, otherwise return 0.
9092 gdb_caching_proc linker_supports_Ttext_segment_flag {} {
9093 set me "linker_supports_Ttext_segment_flag"
9094 set flags ldflags="-Wl,-Ttext-segment=0x7000000"
9095 set src { int main() { return 0; } }
9096 return [gdb_simple_compile $me $src executable $flags]
9099 # Return 1 if linker supports -Ttext, otherwise return 0.
9100 gdb_caching_proc linker_supports_Ttext_flag {} {
9101 set me "linker_supports_Ttext_flag"
9102 set flags ldflags="-Wl,-Ttext=0x7000000"
9103 set src { int main() { return 0; } }
9104 return [gdb_simple_compile $me $src executable $flags]
9107 # Return 1 if linker supports --image-base, otherwise 0.
9108 gdb_caching_proc linker_supports_image_base_flag {} {
9109 set me "linker_supports_image_base_flag"
9110 set flags ldflags="-Wl,--image-base=0x7000000"
9111 set src { int main() { return 0; } }
9112 return [gdb_simple_compile $me $src executable $flags]
9116 # Return 1 if compiler supports scalar_storage_order attribute, otherwise
9118 gdb_caching_proc supports_scalar_storage_order_attribute {} {
9119 set me "supports_scalar_storage_order_attribute"
9124 } __attribute__((scalar_storage_order("little-endian")));
9127 } __attribute__((scalar_storage_order("big-endian")));
9131 sle.v = sbe.v = 0x11223344;
9132 int same = memcmp (&sle, &sbe, sizeof (int)) == 0;
9137 if { ![gdb_simple_compile $me $src executable ""] } {
9141 set target_obj [gdb_remote_download target $obj]
9142 set result [remote_exec target $target_obj]
9143 set status [lindex $result 0]
9144 set output [lindex $result 1]
9145 if { $output != "" } {
9152 # Return 1 if compiler supports __GNUC__, otherwise return 0.
9153 gdb_caching_proc supports_gnuc {} {
9154 set me "supports_gnuc"
9160 return [gdb_simple_compile $me $src object ""]
9163 # Return 1 if target supports mpx, otherwise return 0.
9164 gdb_caching_proc have_mpx {} {
9168 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
9169 verbose "$me: target does not support mpx, returning 0" 2
9173 # Compile a test program.
9175 #include "nat/x86-cpuid.h"
9178 unsigned int eax, ebx, ecx, edx;
9180 if (!__get_cpuid (1, &eax, &ebx, &ecx, &edx))
9183 if ((ecx & bit_OSXSAVE) == bit_OSXSAVE)
9185 if (__get_cpuid_max (0, (void *)0) < 7)
9188 __cpuid_count (7, 0, eax, ebx, ecx, edx);
9190 if ((ebx & bit_MPX) == bit_MPX)
9197 set compile_flags "incdir=${srcdir}/.."
9198 if {![gdb_simple_compile $me $src executable $compile_flags]} {
9202 set target_obj [gdb_remote_download target $obj]
9203 set result [remote_exec target $target_obj]
9204 set status [lindex $result 0]
9205 set output [lindex $result 1]
9206 if { $output != "" } {
9210 remote_file build delete $obj
9212 if { $status == 0 } {
9213 verbose "$me: returning $status" 2
9217 # Compile program with -mmpx -fcheck-pointer-bounds, try to trigger
9218 # 'No MPX support', in other words, see if kernel supports mpx.
9219 set src { int main (void) { return 0; } }
9221 append comp_flags " additional_flags=-mmpx"
9222 append comp_flags " additional_flags=-fcheck-pointer-bounds"
9223 if {![gdb_simple_compile $me-2 $src executable $comp_flags]} {
9227 set target_obj [gdb_remote_download target $obj]
9228 set result [remote_exec target $target_obj]
9229 set status [lindex $result 0]
9230 set output [lindex $result 1]
9231 set status [expr ($status == 0) \
9232 && ![regexp "^No MPX support\r?\n" $output]]
9234 remote_file build delete $obj
9236 verbose "$me: returning $status" 2
9240 # Return 1 if target supports avx, otherwise return 0.
9241 gdb_caching_proc have_avx {} {
9245 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
9246 verbose "$me: target does not support avx, returning 0" 2
9250 # Compile a test program.
9252 #include "nat/x86-cpuid.h"
9255 unsigned int eax, ebx, ecx, edx;
9257 if (!x86_cpuid (1, &eax, &ebx, &ecx, &edx))
9260 if ((ecx & (bit_AVX | bit_OSXSAVE)) == (bit_AVX | bit_OSXSAVE))
9266 set compile_flags "incdir=${srcdir}/.."
9267 if {![gdb_simple_compile $me $src executable $compile_flags]} {
9271 set target_obj [gdb_remote_download target $obj]
9272 set result [remote_exec target $target_obj]
9273 set status [lindex $result 0]
9274 set output [lindex $result 1]
9275 if { $output != "" } {
9279 remote_file build delete $obj
9281 verbose "$me: returning $status" 2
9288 # ARG can either be a name, or of the form !NAME.
9290 # Each name is a proc to evaluate in the caller's context. It can return a
9291 # boolean or a two element list with a boolean and a reason string.
9292 # A "!" means to invert the result. If this is true, all is well. If it is
9293 # false, an "unsupported" is emitted and this proc causes the caller to return.
9295 # The reason string is used to provide some context about a require failure,
9296 # and is included in the "unsupported" message.
9298 proc require { args } {
9300 if {[string index $arg 0] == "!"} {
9302 set fn [string range $arg 1 end]
9308 set result [uplevel 1 $fn]
9309 set len [llength $result]
9311 set actual_val [lindex $result 0]
9312 set msg [lindex $result 1]
9313 } elseif { $len == 1 } {
9314 set actual_val $result
9317 error "proc $fn returned a list of unexpected length $len"
9320 if {$required_val != !!$actual_val} {
9321 if { [string length $msg] > 0 } {
9322 unsupported "require failed: $arg ($msg)"
9324 unsupported "require failed: $arg"
9327 return -code return 0
9332 # Wait up to ::TIMEOUT seconds for file PATH to exist on the target system.
9333 # Return 1 if it does exist, 0 otherwise.
9335 proc target_file_exists_with_timeout { path } {
9336 for {set i 0} {$i < $::timeout} {incr i} {
9337 if { [remote_file target exists $path] } {
9347 gdb_caching_proc has_hw_wp_support {} {
9348 # Power 9, proc rev 2.2 does not support HW watchpoints due to HW bug.
9349 # Need to use a runtime test to determine if the Power processor has
9350 # support for HW watchpoints.
9351 global srcdir subdir gdb_prompt inferior_exited_re
9353 set me "has_hw_wp_support"
9356 if { [info exists gdb_spawn_id] } {
9357 error "$me called with running gdb instance"
9360 set compile_flags {debug nowarnings quiet}
9362 # Compile a test program to test if HW watchpoints are supported
9373 if {![gdb_simple_compile $me $src executable $compile_flags]} {
9378 gdb_reinitialize_dir $srcdir/$subdir
9383 remote_file build delete $obj
9385 set has_hw_wp_support 0
9386 return $has_hw_wp_support
9389 # The goal is to determine if HW watchpoints are available in general.
9390 # Use "watch" and then check if gdb responds with hardware watch point.
9391 set test "watch local"
9393 gdb_test_multiple $test "Check for HW watchpoint support" {
9394 -re ".*Hardware watchpoint.*" {
9395 # HW watchpoint supported by platform
9396 verbose -log "\n$me: Hardware watchpoint detected"
9397 set has_hw_wp_support 1
9399 -re ".*$gdb_prompt $" {
9400 set has_hw_wp_support 0
9401 verbose -log "\n$me: Default, hardware watchpoint not deteced"
9406 remote_file build delete $obj
9408 verbose "$me: returning $has_hw_wp_support" 2
9409 return $has_hw_wp_support
9412 # Return a list of all the accepted values of the set command
9413 # "SET_CMD SET_ARG".
9414 # For example get_set_option_choices "set architecture" "i386".
9416 proc get_set_option_choices { set_cmd {set_arg ""} } {
9419 if { $set_arg == "" } {
9420 # Add trailing space to signal that we need completion of the choices,
9421 # not of set_cmd itself.
9422 set cmd "complete $set_cmd "
9424 set cmd "complete $set_cmd $set_arg"
9427 # Set test name without trailing space.
9428 set test [string trim $cmd]
9430 with_set max-completions unlimited {
9431 gdb_test_multiple $cmd $test {
9432 -re "^[string_to_regexp $cmd]\r\n" {
9436 -re "^$set_cmd (\[^\r\n\]+)\r\n" {
9437 lappend values $expect_out(1,string)
9441 -re "^$::gdb_prompt $" {
9450 # Return the compiler that can generate 32-bit ARM executables. Used
9451 # when testing biarch support on Aarch64. If ARM_CC_FOR_TARGET is
9452 # set, use that. If not, try a few common compiler names, making sure
9453 # that the executable they produce can run.
9455 gdb_caching_proc arm_cc_for_target {} {
9456 if {[info exists ::ARM_CC_FOR_TARGET]} {
9457 # If the user specified the compiler explicitly, then don't
9458 # check whether the resulting binary runs outside GDB. Assume
9459 # that it does, and if it turns out it doesn't, then the user
9460 # should get loud FAILs, instead of UNSUPPORTED.
9461 return $::ARM_CC_FOR_TARGET
9464 # Fallback to a few common compiler names. Also confirm the
9465 # produced binary actually runs on the system before declaring
9466 # we've found the right compiler.
9468 if [istarget "*-linux*-*"] {
9470 arm-linux-gnueabi-gcc
9471 arm-none-linux-gnueabi-gcc
9472 arm-linux-gnueabihf-gcc
9478 foreach compiler $compilers {
9479 if {![is_remote host] && [which $compiler] == 0} {
9480 # Avoid "default_target_compile: Can't find
9481 # $compiler." warning issued from gdb_compile.
9485 set src { int main() { return 0; } }
9486 if {[gdb_simple_compile aarch64-32bit \
9488 executable [list compiler=$compiler]]} {
9490 set target_obj [gdb_remote_download target $obj]
9491 set result [remote_exec target $target_obj]
9492 set status [lindex $result 0]
9493 set output [lindex $result 1]
9497 if { $output == "" && $status == 0} {
9506 # Step until the pattern REGEXP is found. Step at most
9507 # MAX_STEPS times, but stop stepping once REGEXP is found.
9508 # CURRENT matches current location
9509 # If REGEXP is found then a single pass is emitted, otherwise, after
9510 # MAX_STEPS steps, a single fail is emitted.
9512 # TEST_NAME is the name used in the pass/fail calls.
9514 proc gdb_step_until { regexp {test_name "stepping until regexp"} \
9515 {current "\}"} { max_steps 10 } } {
9516 repeat_cmd_until "step" $current $regexp $test_name "10"
9519 # Do repeated stepping COMMANDs in order to reach TARGET from CURRENT
9521 # COMMAND is a stepping command
9522 # CURRENT is a string matching the current location
9523 # TARGET is a string matching the target location
9524 # TEST_NAME is the test name
9525 # MAX_STEPS is number of steps attempted before fail is emitted
9527 # The function issues repeated COMMANDs as long as the location matches
9528 # CURRENT up to a maximum of MAX_STEPS.
9530 # TEST_NAME passes if the resulting location matches TARGET and fails
9533 proc repeat_cmd_until { command current target \
9534 {test_name "stepping until regexp"} \
9539 gdb_test_multiple "$command" "$test_name" {
9540 -re "$current.*$gdb_prompt $" {
9542 if { $count < $max_steps } {
9543 send_gdb "$command\n"
9549 -re "$target.*$gdb_prompt $" {
9555 # Return false if the current target is not operating in non-stop
9556 # mode, otherwise, return true.
9558 # The inferior will need to have started running in order to get the
9561 proc is_target_non_stop { {testname ""} } {
9562 # For historical reasons we assume non-stop mode is on. If the
9563 # maintenance command fails for any reason then we're going to
9565 set is_non_stop true
9566 gdb_test_multiple "maint show target-non-stop" $testname {
9567 -wrap -re "(is|currently) on.*" {
9568 set is_non_stop true
9570 -wrap -re "(is|currently) off.*" {
9571 set is_non_stop false
9577 # Check if the compiler emits epilogue information associated
9578 # with the closing brace or with the last statement line.
9580 # This proc restarts GDB
9582 # Returns True if it is associated with the closing brace,
9583 # False if it is the last statement
9584 gdb_caching_proc have_epilogue_line_info {} {
9593 if {![gdb_simple_compile "simple_program" $main]} {
9599 gdb_test_multiple "info line 6" "epilogue test" {
9600 -re -wrap ".*starts at address.*and ends at.*" {
9609 # Decompress file BZ2, and return it.
9611 proc decompress_bz2 { bz2 } {
9612 set copy [standard_output_file [file tail $bz2]]
9613 set copy [remote_download build $bz2 $copy]
9614 if { $copy == "" } {
9618 set res [remote_exec build "bzip2" "-df $copy"]
9619 if { [lindex $res 0] == -1 } {
9623 set copy [regsub {.bz2$} $copy ""]
9624 if { ![remote_file build exists $copy] } {
9631 # Return 1 if the output of "ldd FILE" contains regexp DEP, 0 if it doesn't,
9632 # and -1 if there was a problem running the command.
9634 proc has_dependency { file dep } {
9635 set ldd [gdb_find_ldd]
9636 set command "$ldd $file"
9637 set result [remote_exec host $command]
9638 set status [lindex $result 0]
9639 set output [lindex $result 1]
9640 verbose -log "status of $command is $status"
9641 verbose -log "output of $command is $output"
9642 if { $status != 0 || $output == "" } {
9645 return [regexp $dep $output]
9648 # Detect linux kernel version and return as list of 3 numbers: major, minor,
9649 # and patchlevel. On failure, return an empty list.
9651 gdb_caching_proc linux_kernel_version {} {
9652 if { ![istarget *-*-linux*] } {
9656 set res [remote_exec target "uname -r"]
9657 set status [lindex $res 0]
9658 set output [lindex $res 1]
9659 if { $status != 0 } {
9663 set re ^($::decimal)\\.($::decimal)\\.($::decimal)
9664 if { [regexp $re $output dummy v1 v2 v3] != 1 } {
9668 return [list $v1 $v2 $v3]
9671 # Return 1 if syscall NAME is supported.
9673 proc have_syscall { name } {
9676 "#include <sys/syscall.h>" \
9677 "int var = SYS_$name;"]
9678 set src [join $src "\n"]
9679 return [gdb_can_simple_compile have_syscall_$name $src object]
9682 # Return 1 if compile flag FLAG is supported.
9684 gdb_caching_proc have_compile_flag { flag } {
9685 set src { void foo () {} }
9686 return [gdb_can_simple_compile have_compile_flag_$flag $src object \
9687 additional_flags=$flag]
9690 # Return 1 if we can create an executable using compile and link flag FLAG.
9692 gdb_caching_proc have_compile_and_link_flag { flag } {
9693 set src { int main () { return 0; } }
9694 return [gdb_can_simple_compile have_compile_and_link_flag_$flag $src executable \
9695 additional_flags=$flag]
9698 # Handle include file $srcdir/$subdir/FILE.
9700 proc include_file { file } {
9701 set file [file join $::srcdir $::subdir $file]
9702 if { [is_remote host] } {
9703 set res [remote_download host $file]
9711 # Handle include file FILE, and if necessary update compiler flags variable
9714 proc lappend_include_file { flags file } {
9715 upvar $flags up_flags
9716 if { [is_remote host] } {
9717 gdb_remote_download host $file
9719 set dir [file dirname $file]
9720 if { $dir != [file join $::srcdir $::subdir] } {
9721 lappend up_flags "additional_flags=-I$dir"
9726 # Always load compatibility stuff.