1 # Copyright 1992-2024 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 # Helper function for set_sanitizer/set_sanitizer_default.
50 proc set_sanitizer_1 { env_var var_id val default} {
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 { $default && [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 # Add VAR_ID=VAL to ENV_VAR.
73 proc set_sanitizer { env_var var_id val } {
74 set_sanitizer_1 $env_var $var_id $val 0
77 # Add VAR_ID=VAL to ENV_VAR, unless ENV_VAR already contains a VAR_ID setting.
79 proc set_sanitizer_default { env_var var_id val } {
80 set_sanitizer_1 $env_var $var_id $val 1
83 set_sanitizer_default TSAN_OPTIONS suppressions \
84 $srcdir/../tsan-suppressions.txt
86 # When using ThreadSanitizer we may run into the case that a race is detected,
87 # but we see the full stack trace only for one of the two accesses, and the
88 # other one is showing "failed to restore the stack".
89 # Try to prevent this by setting history_size to the maximum (7) by default.
90 # See also the ThreadSanitizer docs (
91 # https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags ).
92 set_sanitizer_default TSAN_OPTIONS history_size 7
94 # If GDB is built with ASAN (and because there are leaks), it will output a
95 # leak report when exiting as well as exit with a non-zero (failure) status.
96 # This can affect tests that are sensitive to what GDB prints on stderr or its
97 # exit status. Add `detect_leaks=0` to the ASAN_OPTIONS environment variable
98 # (which will affect any spawned sub-process) to avoid this.
99 set_sanitizer_default ASAN_OPTIONS detect_leaks 0
101 # List of procs to run in gdb_finish.
102 set gdb_finish_hooks [list]
104 # Variable in which we keep track of globals that are allowed to be live
106 array set gdb_persistent_globals {}
108 # Mark variable names in ARG as a persistent global, and declare them as
109 # global in the calling context. Can be used to rewrite "global var_a var_b"
110 # into "gdb_persistent_global var_a var_b".
111 proc gdb_persistent_global { args } {
112 global gdb_persistent_globals
113 foreach varname $args {
114 uplevel 1 global $varname
115 set gdb_persistent_globals($varname) 1
119 # Mark variable names in ARG as a persistent global.
120 proc gdb_persistent_global_no_decl { args } {
121 global gdb_persistent_globals
122 foreach varname $args {
123 set gdb_persistent_globals($varname) 1
127 # Override proc load_lib.
128 rename load_lib saved_load_lib
129 # Run the runtest version of load_lib, and mark all variables that were
130 # created by this call as persistent.
131 proc load_lib { file } {
132 array set known_global {}
133 foreach varname [info globals] {
134 set known_globals($varname) 1
137 set code [catch "saved_load_lib $file" result]
139 foreach varname [info globals] {
140 if { ![info exists known_globals($varname)] } {
141 gdb_persistent_global_no_decl $varname
146 global errorInfo errorCode
147 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
148 } elseif {$code > 1} {
149 return -code $code $result
155 load_lib libgloss.exp
157 load_lib gdb-utils.exp
159 load_lib check-test-names.exp
161 # The path to the GDB binary to test.
164 # The data directory to use for testing. If this is the empty string,
165 # then we let GDB use its own configured data directory.
166 global GDB_DATA_DIRECTORY
168 # The spawn ID used for I/O interaction with the inferior. For native
169 # targets, or remote targets that can do I/O through GDB
170 # (semi-hosting) this will be the same as the host/GDB's spawn ID.
171 # Otherwise, the board may set this to some other spawn ID. E.g.,
172 # when debugging with GDBserver, this is set to GDBserver's spawn ID,
173 # so input/output is done on gdbserver's tty.
174 global inferior_spawn_id
176 if [info exists TOOL_EXECUTABLE] {
177 set GDB $TOOL_EXECUTABLE
179 if ![info exists GDB] {
180 if ![is_remote host] {
181 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
183 set GDB [transform gdb]
186 # If the user specifies GDB on the command line, and doesn't
187 # specify GDB_DATA_DIRECTORY, then assume we're testing an
188 # installed GDB, and let it use its own configured data directory.
189 if ![info exists GDB_DATA_DIRECTORY] {
190 set GDB_DATA_DIRECTORY ""
193 verbose "using GDB = $GDB" 2
195 # The data directory the testing GDB will use. By default, assume
196 # we're testing a non-installed GDB in the build directory. Users may
197 # also explicitly override the -data-directory from the command line.
198 if ![info exists GDB_DATA_DIRECTORY] {
199 set GDB_DATA_DIRECTORY [file normalize "[pwd]/../data-directory"]
201 verbose "using GDB_DATA_DIRECTORY = $GDB_DATA_DIRECTORY" 2
203 # GDBFLAGS is available for the user to set on the command line.
204 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
205 # Testcases may use it to add additional flags, but they must:
206 # - append new flags, not overwrite
207 # - restore the original value when done
209 if ![info exists GDBFLAGS] {
212 verbose "using GDBFLAGS = $GDBFLAGS" 2
214 # Append the -data-directory option to pass to GDB to CMDLINE and
215 # return the resulting string. If GDB_DATA_DIRECTORY is empty,
216 # nothing is appended.
217 proc append_gdb_data_directory_option {cmdline} {
218 global GDB_DATA_DIRECTORY
220 if { $GDB_DATA_DIRECTORY != "" } {
221 return "$cmdline -data-directory $GDB_DATA_DIRECTORY"
227 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
228 # `-nw' disables any of the windowed interfaces.
229 # `-nx' disables ~/.gdbinit, so that it doesn't interfere with the tests.
230 # `-iex "set {height,width} 0"' disables pagination.
231 # `-data-directory' points to the data directory, usually in the build
233 global INTERNAL_GDBFLAGS
234 if ![info exists INTERNAL_GDBFLAGS] {
235 set INTERNAL_GDBFLAGS \
240 {-iex "set height 0"} \
241 {-iex "set width 0"}]]
243 # If DEBUGINFOD_URLS is set, gdb will try to download sources and
244 # debug info for f.i. system libraries. Prevent this.
245 if { [is_remote host] } {
246 # Setting environment variables on build has no effect on remote host,
247 # so handle this using "set debuginfod enabled off" instead.
248 set INTERNAL_GDBFLAGS \
249 "$INTERNAL_GDBFLAGS -iex \"set debuginfod enabled off\""
251 # See default_gdb_init.
254 set INTERNAL_GDBFLAGS [append_gdb_data_directory_option $INTERNAL_GDBFLAGS]
257 # The variable gdb_prompt is a regexp which matches the gdb prompt.
258 # Set it if it is not already set. This is also set by default_gdb_init
259 # but it's not clear what removing one of them will break.
260 # See with_gdb_prompt for more details on prompt handling.
262 if {![info exists gdb_prompt]} {
263 set gdb_prompt "\\(gdb\\)"
266 # A regexp that matches the pagination prompt.
267 set pagination_prompt \
268 "--Type <RET> for more, q to quit, c to continue without paging--"
270 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
271 # absolute path ie. /foo/
272 set fullname_syntax_POSIX {/[^\n]*/}
273 # The variable fullname_syntax_UNC is a regexp which matches a Windows
274 # UNC path ie. \\D\foo\
275 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
276 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
277 # particular DOS case that GDB most likely will output
278 # ie. \foo\, but don't match \\.*\
279 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
280 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
281 # ie. a:\foo\ && a:foo\
282 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
283 # The variable fullname_syntax is a regexp which matches what GDB considers
284 # an absolute path. It is currently debatable if the Windows style paths
285 # d:foo and \abc should be considered valid as an absolute path.
286 # Also, the purpse of this regexp is not to recognize a well formed
287 # absolute path, but to say with certainty that a path is absolute.
288 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
290 # Needed for some tests under Cygwin.
294 if ![info exists env(EXEEXT)] {
297 set EXEEXT $env(EXEEXT)
302 set inferior_exited_re "(?:\\\[Inferior \[0-9\]+ \\(\[^\n\r\]*\\) exited)"
304 # A regular expression that matches the first word of a thread
305 # description after the thread number info 'info threads'
306 set tdlabel_re "(process|Thread|LWP)"
308 # A regular expression that matches a value history number.
310 set valnum_re "\\\$$decimal"
312 # A regular expression that matches a breakpoint hit with a breakpoint
313 # having several code locations.
314 set bkptno_num_re "$decimal\\.$decimal"
316 # A regular expression that matches a breakpoint hit
317 # with one or several code locations.
318 set bkptno_numopt_re "($decimal\\.$decimal|$decimal)"
320 ### Only procedures should come after this point.
323 # gdb_version -- extract and print the version number of GDB
325 proc default_gdb_version {} {
327 global INTERNAL_GDBFLAGS GDBFLAGS
331 if {[info exists inotify_pid]} {
332 eval exec kill $inotify_pid
335 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
336 set tmp [lindex $output 1]
338 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
339 if ![is_remote host] {
340 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
342 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
346 proc gdb_version { } {
347 return [default_gdb_version]
350 # gdb_unload -- unload a file if one is loaded
352 # Returns the same as gdb_test_multiple.
354 proc gdb_unload { {msg "file"} } {
357 return [gdb_test_multiple "file" $msg {
358 -re "A program is being debugged already.\r\nAre you sure you want to change the file. .y or n. $" {
359 send_gdb "y\n" answer
363 -re "No executable file now\\.\r\n" {
367 -re "Discard symbol table from `.*'. .y or n. $" {
368 send_gdb "y\n" answer
372 -re -wrap "No symbol file now\\." {
378 # Many of the tests depend on setting breakpoints at various places and
379 # running until that breakpoint is reached. At times, we want to start
380 # with a clean-slate with respect to breakpoints, so this utility proc
381 # lets us do this without duplicating this code everywhere.
384 proc delete_breakpoints {} {
387 # we need a larger timeout value here or this thing just confuses
388 # itself. May need a better implementation if possible. - guo
392 set msg "delete all breakpoints, watchpoints, tracepoints, and catchpoints in delete_breakpoints"
394 gdb_test_multiple "delete breakpoints" "$msg" {
395 -re "Delete all breakpoints, watchpoints, tracepoints, and catchpoints.*y or n.*$" {
396 send_gdb "y\n" answer
399 -re "$gdb_prompt $" {
405 # Confirm with "info breakpoints".
407 set msg "info breakpoints"
408 gdb_test_multiple $msg $msg {
409 -re "No breakpoints, watchpoints, tracepoints, or catchpoints..*$gdb_prompt $" {
412 -re "$gdb_prompt $" {
418 perror "breakpoints not deleted"
422 # Returns true iff the target supports using the "run" command.
424 proc target_can_use_run_cmd { {target_description ""} } {
425 if { $target_description == "" } {
427 } elseif { $target_description == "core" } {
428 # We could try to figure this out by issuing an "info target" and
429 # checking for "Local core dump file:", but it would mean the proc
430 # would start requiring a current target. Also, uses while gdb
431 # produces non-standard output due to, say annotations would
432 # have to be moved around or eliminated, which would further limit
436 error "invalid argument: $target_description"
439 if [target_info exists use_gdb_stub] {
440 # In this case, when we connect, the inferior is already
445 if { $have_core && [target_info gdb_protocol] == "extended-remote" } {
446 # In this case, when we connect, the inferior is not running but
447 # cannot be made to run.
455 # Generic run command.
457 # Return 0 if we could start the program, -1 if we could not.
459 # The second pattern below matches up to the first newline *only*.
460 # Using ``.*$'' could swallow up output that we attempt to match
463 # INFERIOR_ARGS is passed as arguments to the start command, so may contain
464 # inferior arguments.
466 # N.B. This function does not wait for gdb to return to the prompt,
467 # that is the caller's responsibility.
469 proc gdb_run_cmd { {inferior_args {}} } {
470 global gdb_prompt use_gdb_stub
472 foreach command [gdb_init_commands] {
473 send_gdb "$command\n"
475 -re "$gdb_prompt $" { }
477 perror "gdb_init_command for target failed"
484 if [target_info exists gdb,do_reload_on_run] {
485 if { [gdb_reload $inferior_args] != 0 } {
488 send_gdb "continue\n"
490 -re "Continu\[^\r\n\]*\[\r\n\]" {}
496 if [target_info exists gdb,start_symbol] {
497 set start [target_info gdb,start_symbol]
501 send_gdb "jump *$start\n"
503 while { $start_attempt } {
504 # Cap (re)start attempts at three to ensure that this loop
505 # always eventually fails. Don't worry about trying to be
506 # clever and not send a command when it has failed.
507 if [expr $start_attempt > 3] {
508 perror "Jump to start() failed (retry count exceeded)"
511 set start_attempt [expr $start_attempt + 1]
513 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
516 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
517 perror "Can't find start symbol to run in gdb_run"
520 -re "No symbol \"start\" in current.*$gdb_prompt $" {
521 send_gdb "jump *_start\n"
523 -re "No symbol.*context.*$gdb_prompt $" {
526 -re "Line.* Jump anyway.*y or n. $" {
527 send_gdb "y\n" answer
529 -re "The program is not being run.*$gdb_prompt $" {
530 if { [gdb_reload $inferior_args] != 0 } {
533 send_gdb "jump *$start\n"
536 perror "Jump to start() failed (timeout)"
545 if [target_info exists gdb,do_reload_on_run] {
546 if { [gdb_reload $inferior_args] != 0 } {
550 send_gdb "run $inferior_args\n"
551 # This doesn't work quite right yet.
552 # Use -notransfer here so that test cases (like chng-sym.exp)
553 # may test for additional start-up messages.
555 -re "The program .* has been started already.*y or n. $" {
556 send_gdb "y\n" answer
559 -notransfer -re "Starting program: \[^\r\n\]*" {}
560 -notransfer -re "$gdb_prompt $" {
561 # There is no more input expected.
563 -notransfer -re "A problem internal to GDB has been detected" {
564 # Let caller handle this.
571 # Generic start command. Return 0 if we could start the program, -1
574 # INFERIOR_ARGS is passed as arguments to the start command, so may contain
575 # inferior arguments.
577 # N.B. This function does not wait for gdb to return to the prompt,
578 # that is the caller's responsibility.
580 proc gdb_start_cmd { {inferior_args {}} } {
581 global gdb_prompt use_gdb_stub
583 foreach command [gdb_init_commands] {
584 send_gdb "$command\n"
586 -re "$gdb_prompt $" { }
588 perror "gdb_init_command for target failed"
598 send_gdb "start $inferior_args\n"
599 # Use -notransfer here so that test cases (like chng-sym.exp)
600 # may test for additional start-up messages.
602 -re "The program .* has been started already.*y or n. $" {
603 send_gdb "y\n" answer
606 -notransfer -re "Starting program: \[^\r\n\]*" {
609 -re "$gdb_prompt $" { }
614 # Generic starti command. Return 0 if we could start the program, -1
617 # INFERIOR_ARGS is passed as arguments to the starti command, so may contain
618 # inferior arguments.
620 # N.B. This function does not wait for gdb to return to the prompt,
621 # that is the caller's responsibility.
623 proc gdb_starti_cmd { {inferior_args {}} } {
624 global gdb_prompt use_gdb_stub
626 foreach command [gdb_init_commands] {
627 send_gdb "$command\n"
629 -re "$gdb_prompt $" { }
631 perror "gdb_init_command for target failed"
641 send_gdb "starti $inferior_args\n"
643 -re "The program .* has been started already.*y or n. $" {
644 send_gdb "y\n" answer
647 -re "Starting program: \[^\r\n\]*" {
654 # Set a breakpoint using LINESPEC.
656 # If there is an additional argument it is a list of options; the supported
657 # options are allow-pending, temporary, message, no-message and qualified.
659 # The result is 1 for success, 0 for failure.
661 # Note: The handling of message vs no-message is messed up, but it's based
662 # on historical usage. By default this function does not print passes,
664 # no-message: turns off printing of fails (and passes, but they're already off)
665 # message: turns on printing of passes (and fails, but they're already on)
667 proc gdb_breakpoint { linespec args } {
671 set pending_response n
672 if {[lsearch -exact $args allow-pending] != -1} {
673 set pending_response y
676 set break_command "break"
677 set break_message "Breakpoint"
678 if {[lsearch -exact $args temporary] != -1} {
679 set break_command "tbreak"
680 set break_message "Temporary breakpoint"
683 if {[lsearch -exact $args qualified] != -1} {
684 append break_command " -qualified"
689 set no_message_loc [lsearch -exact $args no-message]
690 set message_loc [lsearch -exact $args message]
691 # The last one to appear in args wins.
692 if { $no_message_loc > $message_loc } {
694 } elseif { $message_loc > $no_message_loc } {
698 set test_name "gdb_breakpoint: set breakpoint at $linespec"
699 # The first two regexps are what we get with -g, the third is without -g.
700 gdb_test_multiple "$break_command $linespec" $test_name {
701 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
702 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
703 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
704 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
705 if {$pending_response == "n"} {
712 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
713 send_gdb "$pending_response\n"
716 -re "$gdb_prompt $" {
729 # Set breakpoint at function and run gdb until it breaks there.
730 # Since this is the only breakpoint that will be set, if it stops
731 # at a breakpoint, we will assume it is the one we want. We can't
732 # just compare to "function" because it might be a fully qualified,
733 # single quoted C++ function specifier.
735 # If there are additional arguments, pass them to gdb_breakpoint.
736 # We recognize no-message/message ourselves.
738 # no-message is messed up here, like gdb_breakpoint: to preserve
739 # historical usage fails are always printed by default.
740 # no-message: turns off printing of fails (and passes, but they're already off)
741 # message: turns on printing of passes (and fails, but they're already on)
743 proc runto { linespec args } {
745 global bkptno_numopt_re
752 set no_message_loc [lsearch -exact $args no-message]
753 set message_loc [lsearch -exact $args message]
754 # The last one to appear in args wins.
755 if { $no_message_loc > $message_loc } {
757 } elseif { $message_loc > $no_message_loc } {
761 set test_name "runto: run to $linespec"
763 if {![gdb_breakpoint $linespec {*}$args]} {
769 # the "at foo.c:36" output we get with -g.
770 # the "in func" output we get without -g.
772 -re "(?:Break|Temporary break).* at .*:$decimal.*$gdb_prompt $" {
778 -re "(?:Breakpoint|Temporary breakpoint) $bkptno_numopt_re, \[0-9xa-f\]* in .*$gdb_prompt $" {
784 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
786 unsupported "non-stop mode not supported"
790 -re ".*A problem internal to GDB has been detected" {
791 # Always emit a FAIL if we encounter an internal error: internal
792 # errors are never expected.
793 fail "$test_name (GDB internal error)"
794 gdb_internal_error_resync
797 -re "$gdb_prompt $" {
805 fail "$test_name (eof)"
811 fail "$test_name (timeout)"
822 # Ask gdb to run until we hit a breakpoint at main.
824 # N.B. This function deletes all existing breakpoints.
825 # If you don't want that, use gdb_start_cmd.
827 proc runto_main { } {
828 return [runto main qualified]
831 ### Continue, and expect to hit a breakpoint.
832 ### Report a pass or fail, depending on whether it seems to have
833 ### worked. Use NAME as part of the test name; each call to
834 ### continue_to_breakpoint should use a NAME which is unique within
836 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
838 set full_name "continue to breakpoint: $name"
840 set kfail_pattern "Process record does not support instruction 0xfae64 at.*"
841 return [gdb_test_multiple "continue" $full_name {
842 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
845 -re "(?:$kfail_pattern)\r\n$gdb_prompt $" {
846 kfail "gdb/25038" $full_name
852 # gdb_internal_error_resync:
854 # Answer the questions GDB asks after it reports an internal error
855 # until we get back to a GDB prompt. Decline to quit the debugging
856 # session, and decline to create a core file. Return non-zero if the
859 # This procedure just answers whatever questions come up until it sees
860 # a GDB prompt; it doesn't require you to have matched the input up to
861 # any specific point. However, it only answers questions it sees in
862 # the output itself, so if you've matched a question, you had better
863 # answer it yourself before calling this.
865 # You can use this function thus:
869 # -re ".*A problem internal to GDB has been detected" {
870 # gdb_internal_error_resync
875 proc gdb_internal_error_resync {} {
878 verbose -log "Resyncing due to internal error."
881 while {$count < 10} {
883 -re "Recursive internal problem\\." {
884 perror "Could not resync from internal error (recursive internal problem)"
887 -re "Quit this debugging session\\? \\(y or n\\) $" {
888 send_gdb "n\n" answer
891 -re "Create a core file of GDB\\? \\(y or n\\) $" {
892 send_gdb "n\n" answer
895 -re "$gdb_prompt $" {
896 # We're resynchronized.
900 perror "Could not resync from internal error (timeout)"
904 perror "Could not resync from internal error (eof)"
909 perror "Could not resync from internal error (resync count exceeded)"
913 # Fill in the default prompt if PROMPT_REGEXP is empty.
915 # If WITH_ANCHOR is true and the default prompt is used, append a `$` at the end
916 # of the regexp, to anchor the match at the end of the buffer.
917 proc fill_in_default_prompt {prompt_regexp with_anchor} {
918 if { "$prompt_regexp" == "" } {
919 set prompt "$::gdb_prompt "
921 if { $with_anchor } {
927 return $prompt_regexp
930 # gdb_test_multiple COMMAND MESSAGE [ -prompt PROMPT_REGEXP] [ -lbl ]
932 # Send a command to gdb; test the result.
934 # COMMAND is the command to execute, send to GDB with send_gdb. If
935 # this is the null string no command is sent.
936 # MESSAGE is a message to be printed with the built-in failure patterns
937 # if one of them matches. If MESSAGE is empty COMMAND will be used.
938 # -prompt PROMPT_REGEXP specifies a regexp matching the expected prompt
939 # after the command output. If empty, defaults to "$gdb_prompt $".
940 # -lbl specifies that line-by-line matching will be used.
941 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
942 # patterns. Pattern elements will be evaluated in the caller's
943 # context; action elements will be executed in the caller's context.
944 # Unlike patterns for gdb_test, these patterns should generally include
945 # the final newline and prompt.
948 # 1 if the test failed, according to a built-in failure pattern
949 # 0 if only user-supplied patterns matched
950 # -1 if there was an internal error.
952 # You can use this function thus:
954 # gdb_test_multiple "print foo" "test foo" {
955 # -re "expected output 1" {
958 # -re "expected output 2" {
963 # Within action elements you can also make use of the variable
964 # gdb_test_name. This variable is setup automatically by
965 # gdb_test_multiple, and contains the value of MESSAGE. You can then
966 # write this, which is equivalent to the above:
968 # gdb_test_multiple "print foo" "test foo" {
969 # -re "expected output 1" {
970 # pass $gdb_test_name
972 # -re "expected output 2" {
973 # fail $gdb_test_name
977 # Like with "expect", you can also specify the spawn id to match with
978 # -i "$id". Interesting spawn ids are $inferior_spawn_id and
979 # $gdb_spawn_id. The former matches inferior I/O, while the latter
980 # matches GDB I/O. E.g.:
982 # send_inferior "hello\n"
983 # gdb_test_multiple "continue" "test echo" {
984 # -i "$inferior_spawn_id" -re "^hello\r\nhello\r\n$" {
987 # -i "$gdb_spawn_id" -re "Breakpoint.*$gdb_prompt $" {
988 # fail "hit breakpoint"
992 # The standard patterns, such as "Inferior exited..." and "A problem
993 # ...", all being implicitly appended to that list. These are always
994 # expected from $gdb_spawn_id. IOW, callers do not need to worry
995 # about resetting "-i" back to $gdb_spawn_id explicitly.
997 # In EXPECT_ARGUMENTS we can use a -wrap pattern flag, that wraps the regexp
998 # pattern as gdb_test wraps its message argument.
999 # This allows us to rewrite:
1000 # gdb_test <command> <pattern> <message>
1002 # gdb_test_multiple <command> <message> {
1003 # -re -wrap <pattern> {
1004 # pass $gdb_test_name
1007 # The special handling of '^' that is available in gdb_test is also
1008 # supported in gdb_test_multiple when -wrap is used.
1010 # In EXPECT_ARGUMENTS, a pattern flag -early can be used. It makes sure the
1011 # pattern is inserted before any implicit pattern added by gdb_test_multiple.
1012 # Using this pattern flag, we can f.i. setup a kfail for an assertion failure
1013 # <assert> during gdb_continue_to_breakpoint by the rewrite:
1014 # gdb_continue_to_breakpoint <msg> <pattern>
1016 # set breakpoint_pattern "(?:Breakpoint|Temporary breakpoint) .* (at|in)"
1017 # gdb_test_multiple "continue" "continue to breakpoint: <msg>" {
1018 # -early -re "internal-error: <assert>" {
1019 # setup_kfail gdb/nnnnn "*-*-*"
1022 # -re "$breakpoint_pattern <pattern>\r\n$gdb_prompt $" {
1023 # pass $gdb_test_name
1027 proc gdb_test_multiple { command message args } {
1028 global verbose use_gdb_stub
1029 global gdb_prompt pagination_prompt
1032 global inferior_exited_re
1033 upvar timeout timeout
1034 upvar expect_out expect_out
1038 set prompt_regexp ""
1039 for {set i 0} {$i < [llength $args]} {incr i} {
1040 set arg [lindex $args $i]
1041 if { $arg == "-prompt" } {
1043 set prompt_regexp [lindex $args $i]
1044 } elseif { $arg == "-lbl" } {
1051 if { [expr $i + 1] < [llength $args] } {
1052 error "Too many arguments to gdb_test_multiple"
1053 } elseif { ![info exists user_code] } {
1054 error "Too few arguments to gdb_test_multiple"
1057 set prompt_regexp [fill_in_default_prompt $prompt_regexp true]
1059 if { $message == "" } {
1060 set message $command
1063 if [string match "*\[\r\n\]" $command] {
1064 error "Invalid trailing newline in \"$command\" command"
1067 if [string match "*\[\003\004\]" $command] {
1068 error "Invalid trailing control code in \"$command\" command"
1071 if [string match "*\[\r\n\]*" $message] {
1072 error "Invalid newline in \"$message\" test"
1076 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
1078 error "gdbserver does not support $command without extended-remote"
1081 # TCL/EXPECT WART ALERT
1082 # Expect does something very strange when it receives a single braced
1083 # argument. It splits it along word separators and performs substitutions.
1084 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
1085 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
1086 # double-quoted list item, "\[ab\]" is just a long way of representing
1087 # "[ab]", because the backslashes will be removed by lindex.
1089 # Unfortunately, there appears to be no easy way to duplicate the splitting
1090 # that expect will do from within TCL. And many places make use of the
1091 # "\[0-9\]" construct, so we need to support that; and some places make use
1092 # of the "[func]" construct, so we need to support that too. In order to
1093 # get this right we have to substitute quoted list elements differently
1094 # from braced list elements.
1096 # We do this roughly the same way that Expect does it. We have to use two
1097 # lists, because if we leave unquoted newlines in the argument to uplevel
1098 # they'll be treated as command separators, and if we escape newlines
1099 # we mangle newlines inside of command blocks. This assumes that the
1100 # input doesn't contain a pattern which contains actual embedded newlines
1103 regsub -all {\n} ${user_code} { } subst_code
1104 set subst_code [uplevel list $subst_code]
1106 set processed_code ""
1107 set early_processed_code ""
1108 # The variable current_list holds the name of the currently processed
1109 # list, either processed_code or early_processed_code.
1110 set current_list "processed_code"
1112 set expecting_action 0
1115 foreach item $user_code subst_item $subst_code {
1116 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
1117 lappend $current_list $item
1120 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
1121 lappend $current_list $item
1124 if { $item == "-early" } {
1125 set current_list "early_processed_code"
1128 if { $item == "-timeout" || $item == "-i" } {
1130 lappend $current_list $item
1133 if { $item == "-wrap" } {
1137 if { $expecting_arg } {
1139 lappend $current_list $subst_item
1142 if { $expecting_action } {
1143 lappend $current_list "uplevel [list $item]"
1144 set expecting_action 0
1145 # Cosmetic, no effect on the list.
1146 append $current_list "\n"
1147 # End the effect of -early, it only applies to one action.
1148 set current_list "processed_code"
1151 set expecting_action 1
1152 if { $wrap_pattern } {
1153 # Wrap subst_item as is done for the gdb_test PATTERN argument.
1154 if {[string range $subst_item 0 0] eq "^"} {
1155 if {$command ne ""} {
1156 set command_regex [string_to_regexp $command]
1157 set subst_item [string range $subst_item 1 end]
1158 if {[string length "$subst_item"] > 0} {
1159 # We have an output pattern (other than the '^'),
1160 # add a newline at the start, this will eventually
1161 # sit between the command and the output pattern.
1162 set subst_item "\r\n${subst_item}"
1164 set subst_item "^${command_regex}${subst_item}"
1167 lappend $current_list \
1168 "(?:$subst_item)\r\n$prompt_regexp"
1171 lappend $current_list $subst_item
1173 if {$patterns != ""} {
1174 append patterns "; "
1176 append patterns "\"$subst_item\""
1179 # Also purely cosmetic.
1180 regsub -all {\r} $patterns {\\r} patterns
1181 regsub -all {\n} $patterns {\\n} patterns
1184 send_user "Sending \"$command\" to gdb\n"
1185 send_user "Looking to match \"$patterns\"\n"
1186 send_user "Message is \"$message\"\n"
1190 set string "${command}\n"
1191 if { $command != "" } {
1192 set multi_line_re "\[\r\n\] *>"
1193 while { "$string" != "" } {
1194 set foo [string first "\n" "$string"]
1195 set len [string length "$string"]
1196 if { $foo < [expr $len - 1] } {
1197 set str [string range "$string" 0 $foo]
1198 if { [send_gdb "$str"] != "" } {
1199 verbose -log "Couldn't send $command to GDB."
1203 # since we're checking if each line of the multi-line
1204 # command are 'accepted' by GDB here,
1205 # we need to set -notransfer expect option so that
1206 # command output is not lost for pattern matching
1209 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
1210 timeout { verbose "partial: timeout" 3 }
1212 set string [string range "$string" [expr $foo + 1] end]
1213 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
1218 if { "$string" != "" } {
1219 if { [send_gdb "$string"] != "" } {
1220 verbose -log "Couldn't send $command to GDB."
1227 set code $early_processed_code
1229 -re ".*A problem internal to GDB has been detected" {
1230 fail "$message (GDB internal error)"
1231 gdb_internal_error_resync
1234 -re "\\*\\*\\* DOSEXIT code.*" {
1235 if { $message != "" } {
1240 -re "Corrupted shared library list.*$prompt_regexp" {
1241 fail "$message (shared library list corrupted)"
1244 -re "Invalid cast\.\r\nwarning: Probes-based dynamic linker interface failed.*$prompt_regexp" {
1245 fail "$message (probes interface failure)"
1249 append code $processed_code
1251 # Reset the spawn id, in case the processed code used -i.
1257 -re "Ending remote debugging.*$prompt_regexp" {
1259 warning "Can`t communicate to remote target."
1265 -re "Undefined\[a-z\]* command:.*$prompt_regexp" {
1266 perror "Undefined command \"$command\"."
1270 -re "Ambiguous command.*$prompt_regexp" {
1271 perror "\"$command\" is not a unique command name."
1275 -re "$inferior_exited_re with code \[0-9\]+.*$prompt_regexp" {
1276 if {![string match "" $message]} {
1277 set errmsg "$message (the program exited)"
1279 set errmsg "$command (the program exited)"
1284 -re "$inferior_exited_re normally.*$prompt_regexp" {
1285 if {![string match "" $message]} {
1286 set errmsg "$message (the program exited)"
1288 set errmsg "$command (the program exited)"
1293 -re "The program is not being run.*$prompt_regexp" {
1294 if {![string match "" $message]} {
1295 set errmsg "$message (the program is no longer running)"
1297 set errmsg "$command (the program is no longer running)"
1302 -re "\r\n$prompt_regexp" {
1303 if {![string match "" $message]} {
1308 -re "$pagination_prompt" {
1310 perror "Window too small."
1314 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
1315 send_gdb "n\n" answer
1316 gdb_expect -re "$prompt_regexp"
1317 fail "$message (got interactive prompt)"
1320 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
1322 gdb_expect -re "$prompt_regexp"
1323 fail "$message (got breakpoint menu)"
1329 perror "GDB process no longer exists"
1330 set wait_status [wait -i $gdb_spawn_id]
1331 verbose -log "GDB process exited with wait status $wait_status"
1332 if { $message != "" } {
1339 if {$line_by_line} {
1341 -re "\r\n\[^\r\n\]*(?=\r\n)" {
1347 # Now patterns that apply to any spawn id specified.
1351 perror "Process no longer exists"
1352 if { $message != "" } {
1358 perror "internal buffer is full."
1363 if {![string match "" $message]} {
1364 fail "$message (timeout)"
1370 # remote_expect calls the eof section if there is an error on the
1371 # expect call. We already have eof sections above, and we don't
1372 # want them to get called in that situation. Since the last eof
1373 # section becomes the error section, here we define another eof
1374 # section, but with an empty spawn_id list, so that it won't ever
1378 # This comment is here because the eof section must not be
1379 # the empty string, otherwise remote_expect won't realize
1384 # Create gdb_test_name in the parent scope. If this variable
1385 # already exists, which it might if we have nested calls to
1386 # gdb_test_multiple, then preserve the old value, otherwise,
1387 # create a new variable in the parent scope.
1388 upvar gdb_test_name gdb_test_name
1389 if { [info exists gdb_test_name] } {
1390 set gdb_test_name_old "$gdb_test_name"
1392 set gdb_test_name "$message"
1395 set code [catch {gdb_expect $code} string]
1397 # Clean up the gdb_test_name variable. If we had a
1398 # previous value then restore it, otherwise, delete the variable
1399 # from the parent scope.
1400 if { [info exists gdb_test_name_old] } {
1401 set gdb_test_name "$gdb_test_name_old"
1407 global errorInfo errorCode
1408 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1409 } elseif {$code > 1} {
1410 return -code $code $string
1415 # Usage: gdb_test_multiline NAME INPUT RESULT {INPUT RESULT} ...
1416 # Run a test named NAME, consisting of multiple lines of input.
1417 # After each input line INPUT, search for result line RESULT.
1418 # Succeed if all results are seen; fail otherwise.
1420 proc gdb_test_multiline { name args } {
1423 foreach {input result} $args {
1425 if {[gdb_test_multiple $input "$name: input $inputnr: $input" {
1426 -re "($result)\r\n($gdb_prompt | *>)$" {
1437 # gdb_test [-prompt PROMPT_REGEXP] [-lbl]
1438 # COMMAND [PATTERN] [MESSAGE] [QUESTION RESPONSE]
1439 # Send a command to gdb; test the result.
1441 # COMMAND is the command to execute, send to GDB with send_gdb. If
1442 # this is the null string no command is sent.
1443 # PATTERN is the pattern to match for a PASS, and must NOT include the
1444 # \r\n sequence immediately before the gdb prompt (see -nonl below).
1445 # This argument may be omitted to just match the prompt, ignoring
1446 # whatever output precedes it. If PATTERN starts with '^' then
1447 # PATTERN will be anchored such that it should match all output from
1449 # MESSAGE is an optional message to be printed. If this is
1450 # omitted, then the pass/fail messages use the command string as the
1451 # message. (If this is the empty string, then sometimes we don't
1452 # call pass or fail at all; I don't understand this at all.)
1453 # QUESTION is a question GDB should ask in response to COMMAND, like
1454 # "are you sure?" If this is specified, the test fails if GDB
1455 # doesn't print the question.
1456 # RESPONSE is the response to send when QUESTION appears.
1458 # -prompt PROMPT_REGEXP specifies a regexp matching the expected prompt
1459 # after the command output. If empty, defaults to "$gdb_prompt $".
1460 # -no-prompt-anchor specifies that if the default prompt regexp is used, it
1461 # should not be anchored at the end of the buffer. This means that the
1462 # pattern can match even if there is stuff output after the prompt. Does not
1463 # have any effect if -prompt is specified.
1464 # -lbl specifies that line-by-line matching will be used.
1465 # -nopass specifies that a PASS should not be issued.
1466 # -nonl specifies that no \r\n sequence is expected between PATTERN
1467 # and the gdb prompt.
1470 # 1 if the test failed,
1471 # 0 if the test passes,
1472 # -1 if there was an internal error.
1474 proc gdb_test { args } {
1476 upvar timeout timeout
1486 lassign $args command pattern message question response
1488 # Can't have a question without a response.
1489 if { $question != "" && $response == "" || [llength $args] > 5 } {
1490 error "Unexpected arguments: $args"
1493 if { $message == "" } {
1494 set message $command
1497 set prompt [fill_in_default_prompt $prompt [expr !${no-prompt-anchor}]]
1498 set nl [expr ${nonl} ? {""} : {"\r\n"}]
1502 # If the pattern starts with a '^' then we want to match all the
1503 # output from COMMAND. To support this, here we inject an
1504 # additional pattern that matches the command immediately after
1506 if {[string range $pattern 0 0] eq "^"} {
1507 if {$command ne ""} {
1508 set command_regex [string_to_regexp $command]
1509 set pattern [string range $pattern 1 end]
1510 if {[string length "$pattern"] > 0} {
1511 # We have an output pattern (other than the '^'), add a
1512 # newline at the start, this will eventually sit between the
1513 # command and the output pattern.
1514 set pattern "\r\n$pattern"
1516 set pattern "^${command_regex}${pattern}"
1522 -re "(?:$pattern)$nl$prompt" {
1523 if { $question != "" & !$saw_question} {
1525 } elseif {!$nopass} {
1531 if { $question != "" } {
1535 send_gdb "$response\n"
1541 set user_code [join $user_code]
1544 lappend opts "-prompt" "$prompt"
1549 return [gdb_test_multiple $command $message {*}$opts $user_code]
1552 # Return 1 if python version used is at least MAJOR.MINOR
1553 proc python_version_at_least { major minor } {
1554 set python_script {print (sys.version_info\[0\], sys.version_info\[1\])}
1556 set res [remote_exec host $::GDB \
1557 "$::INTERNAL_GDBFLAGS -batch -ex \"python $python_script\""]
1558 if { [lindex $res 0] != 0 } {
1559 error "Couldn't get python version"
1562 set python_version [lindex $res 1]
1563 set python_version [string trim $python_version]
1565 regexp {^([0-9]+) ([0-9]+)$} $python_version \
1566 dummy python_version_major python_version_minor
1568 return [version_compare [list $major $minor] \
1569 <= [list $python_version_major $python_version_minor]]
1572 # Return 1 if tcl version used is at least MAJOR.MINOR
1573 proc tcl_version_at_least { major minor } {
1575 regexp {^([0-9]+)\.([0-9]+)$} $tcl_version \
1576 dummy tcl_version_major tcl_version_minor
1577 return [version_compare [list $major $minor] \
1578 <= [list $tcl_version_major $tcl_version_minor]]
1581 if { [tcl_version_at_least 8 5] == 0 } {
1582 # lrepeat was added in tcl 8.5. Only add if missing.
1583 proc lrepeat { n element } {
1584 if { [string is integer -strict $n] == 0 } {
1585 error "expected integer but got \"$n\""
1588 error "bad count \"$n\": must be integer >= 0"
1591 for {set i 0} {$i < $n} {incr i} {
1592 lappend res $element
1598 if { [tcl_version_at_least 8 6] == 0 } {
1599 # lmap was added in tcl 8.6. Only add if missing.
1601 # Note that we only implement the simple variant for now.
1602 proc lmap { varname list body } {
1605 uplevel 1 "set $varname $val"
1606 lappend res [uplevel 1 $body]
1613 # gdb_test_no_output [-prompt PROMPT_REGEXP] [-nopass] COMMAND [MESSAGE]
1614 # Send a command to GDB and verify that this command generated no output.
1616 # See gdb_test for a description of the -prompt, -no-prompt-anchor, -nopass,
1617 # COMMAND, and MESSAGE parameters.
1620 # 1 if the test failed,
1621 # 0 if the test passes,
1622 # -1 if there was an internal error.
1624 proc gdb_test_no_output { args } {
1633 lassign $args command message
1635 set prompt [fill_in_default_prompt $prompt [expr !${no-prompt-anchor}]]
1637 set command_regex [string_to_regexp $command]
1638 return [gdb_test_multiple $command $message -prompt $prompt {
1639 -re "^$command_regex\r\n$prompt" {
1647 # Send a command and then wait for a sequence of outputs.
1648 # This is useful when the sequence is long and contains ".*", a single
1649 # regexp to match the entire output can get a timeout much easier.
1651 # COMMAND is the command to execute, send to GDB with send_gdb. If
1652 # this is the null string no command is sent.
1653 # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1654 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1655 # processed in order, and all must be present in the output.
1657 # The -prompt switch can be used to override the prompt expected at the end of
1658 # the output sequence.
1660 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1661 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1662 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1664 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1665 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1668 # 1 if the test failed,
1669 # 0 if the test passes,
1670 # -1 if there was an internal error.
1672 proc gdb_test_sequence { args } {
1675 parse_args {{prompt ""}}
1677 if { $prompt == "" } {
1678 set prompt "$gdb_prompt $"
1681 if { [llength $args] != 3 } {
1682 error "Unexpected # of arguments, expecting: COMMAND TEST_NAME EXPECTED_OUTPUT_LIST"
1685 lassign $args command test_name expected_output_list
1687 if { $test_name == "" } {
1688 set test_name $command
1691 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1693 if { $command != "" } {
1694 send_gdb "$command\n"
1697 return [gdb_expect_list $test_name $prompt $expected_output_list]
1701 # Match output of COMMAND using RE. Read output line-by-line.
1702 # Report pass/fail with MESSAGE.
1703 # For a command foo with output:
1708 # the portion matched using RE is:
1713 # Optionally, additional -re-not <regexp> arguments can be specified, to
1714 # ensure that a regexp is not match by the COMMAND output.
1715 # Such an additional argument generates an additional PASS/FAIL of the form:
1716 # PASS: test-case.exp: $message: pattern not matched: <regexp>
1718 proc gdb_test_lines { command message re args } {
1721 for {set i 0} {$i < [llength $args]} {incr i} {
1722 set arg [lindex $args $i]
1723 if { $arg == "-re-not" } {
1725 if { [llength $args] == $i } {
1726 error "Missing argument for -re-not"
1729 set arg [lindex $args $i]
1732 error "Unhandled argument: $arg"
1736 if { $message == ""} {
1737 set message $command
1741 gdb_test_multiple $command $message {
1742 -re "\r\n(\[^\r\n\]*)(?=\r\n)" {
1743 set line $expect_out(1,string)
1744 if { $lines eq "" } {
1745 append lines "$line"
1747 append lines "\r\n$line"
1756 gdb_assert { [regexp $re $lines] } $message
1758 foreach re $re_not {
1759 gdb_assert { ![regexp $re $lines] } "$message: pattern not matched: $re"
1763 # Test that a command gives an error. For pass or fail, return
1764 # a 1 to indicate that more tests can proceed. However a timeout
1765 # is a serious error, generates a special fail message, and causes
1766 # a 0 to be returned to indicate that more tests are likely to fail
1769 proc test_print_reject { args } {
1773 if {[llength $args] == 2} {
1774 set expectthis [lindex $args 1]
1776 set expectthis "should never match this bogus string"
1778 set sendthis [lindex $args 0]
1780 send_user "Sending \"$sendthis\" to gdb\n"
1781 send_user "Looking to match \"$expectthis\"\n"
1783 send_gdb "$sendthis\n"
1784 #FIXME: Should add timeout as parameter.
1786 -re "A .* in expression.*\\.*$gdb_prompt $" {
1787 pass "reject $sendthis"
1790 -re "Invalid syntax in expression.*$gdb_prompt $" {
1791 pass "reject $sendthis"
1794 -re "Junk after end of expression.*$gdb_prompt $" {
1795 pass "reject $sendthis"
1798 -re "Invalid number.*$gdb_prompt $" {
1799 pass "reject $sendthis"
1802 -re "Invalid character constant.*$gdb_prompt $" {
1803 pass "reject $sendthis"
1806 -re "No symbol table is loaded.*$gdb_prompt $" {
1807 pass "reject $sendthis"
1810 -re "No symbol .* in current context.*$gdb_prompt $" {
1811 pass "reject $sendthis"
1814 -re "Unmatched single quote.*$gdb_prompt $" {
1815 pass "reject $sendthis"
1818 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1819 pass "reject $sendthis"
1822 -re "$expectthis.*$gdb_prompt $" {
1823 pass "reject $sendthis"
1826 -re ".*$gdb_prompt $" {
1827 fail "reject $sendthis"
1831 fail "reject $sendthis (eof or timeout)"
1838 # Same as gdb_test, but the second parameter is not a regexp,
1839 # but a string that must match exactly.
1841 proc gdb_test_exact { args } {
1842 upvar timeout timeout
1844 set command [lindex $args 0]
1846 # This applies a special meaning to a null string pattern. Without
1847 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1848 # messages from commands that should have no output except a new
1849 # prompt. With this, only results of a null string will match a null
1852 set pattern [lindex $args 1]
1853 if [string match $pattern ""] {
1854 set pattern [string_to_regexp [lindex $args 0]]
1856 set pattern [string_to_regexp [lindex $args 1]]
1859 # It is most natural to write the pattern argument with only
1860 # embedded \n's, especially if you are trying to avoid Tcl quoting
1861 # problems. But gdb_expect really wants to see \r\n in patterns. So
1862 # transform the pattern here. First transform \r\n back to \n, in
1863 # case some users of gdb_test_exact already do the right thing.
1864 regsub -all "\r\n" $pattern "\n" pattern
1865 regsub -all "\n" $pattern "\r\n" pattern
1866 if {[llength $args] == 3} {
1867 set message [lindex $args 2]
1868 return [gdb_test $command $pattern $message]
1871 return [gdb_test $command $pattern]
1874 # Wrapper around gdb_test_multiple that looks for a list of expected
1875 # output elements, but which can appear in any order.
1876 # CMD is the gdb command.
1877 # NAME is the name of the test.
1878 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1880 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1881 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1882 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1884 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1885 # of text per element and then strip trailing \r\n's.
1887 # gdb_test_list_exact "foo" "bar" \
1888 # "\[^\r\n\]+\[\r\n\]+" \
1891 # {expected result 1} \
1892 # {expected result 2} \
1895 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1898 set matches [lsort $result_match_list]
1900 gdb_test_multiple $cmd $name {
1901 "$cmd\[\r\n\]" { exp_continue }
1902 -re $elm_find_regexp {
1903 set str $expect_out(0,string)
1904 verbose -log "seen: $str" 3
1905 regexp -- $elm_extract_regexp $str elm_seen
1906 verbose -log "extracted: $elm_seen" 3
1907 lappend seen $elm_seen
1910 -re "$gdb_prompt $" {
1912 foreach got [lsort $seen] have $matches {
1913 if {![string equal $got $have]} {
1918 if {[string length $failed] != 0} {
1919 fail "$name ($failed not found)"
1927 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1928 # Send a command to gdb; expect inferior and gdb output.
1930 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1933 # INFERIOR_PATTERN is the pattern to match against inferior output.
1935 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1936 # include the \r\n sequence immediately before the gdb prompt, nor the
1937 # prompt. The default is empty.
1939 # Both inferior and gdb patterns must match for a PASS.
1941 # If MESSAGE is omitted, then COMMAND will be used as the message.
1944 # 1 if the test failed,
1945 # 0 if the test passes,
1946 # -1 if there was an internal error.
1949 proc gdb_test_stdio {command inferior_pattern {gdb_pattern ""} {message ""}} {
1950 global inferior_spawn_id gdb_spawn_id
1953 if {$message == ""} {
1954 set message $command
1957 set inferior_matched 0
1960 # Use an indirect spawn id list, and remove the inferior spawn id
1961 # from the expected output as soon as it matches, in case
1962 # $inferior_pattern happens to be a prefix of the resulting full
1963 # gdb pattern below (e.g., "\r\n").
1964 global gdb_test_stdio_spawn_id_list
1965 set gdb_test_stdio_spawn_id_list "$inferior_spawn_id"
1967 # Note that if $inferior_spawn_id and $gdb_spawn_id are different,
1968 # then we may see gdb's output arriving before the inferior's
1970 set res [gdb_test_multiple $command $message {
1971 -i gdb_test_stdio_spawn_id_list -re "$inferior_pattern" {
1972 set inferior_matched 1
1973 if {!$gdb_matched} {
1974 set gdb_test_stdio_spawn_id_list ""
1978 -i $gdb_spawn_id -re "$gdb_pattern\r\n$gdb_prompt $" {
1980 if {!$inferior_matched} {
1988 verbose -log "inferior_matched=$inferior_matched, gdb_matched=$gdb_matched"
1993 # Wrapper around gdb_test_multiple to be used when testing expression
1994 # evaluation while 'set debug expression 1' is in effect.
1995 # Looks for some patterns that indicates the expression was rejected.
1997 # CMD is the command to execute, which should include an expression
1998 # that GDB will need to parse.
2000 # OUTPUT is the expected output pattern.
2002 # TESTNAME is the name to be used for the test, defaults to CMD if not
2004 proc gdb_test_debug_expr { cmd output {testname "" }} {
2007 if { ${testname} == "" } {
2011 gdb_test_multiple $cmd $testname {
2012 -re ".*Invalid expression.*\r\n$gdb_prompt $" {
2015 -re ".*\[\r\n\]$output\r\n$gdb_prompt $" {
2021 # get_print_expr_at_depths EXP OUTPUTS
2023 # Used for testing 'set print max-depth'. Prints the expression EXP
2024 # with 'set print max-depth' set to various depths. OUTPUTS is a list
2025 # of `n` different patterns to match at each of the depths from 0 to
2028 # This proc does one final check with the max-depth set to 'unlimited'
2029 # which is tested against the last pattern in the OUTPUTS list. The
2030 # OUTPUTS list is therefore required to match every depth from 0 to a
2031 # depth where the whole of EXP is printed with no ellipsis.
2033 # This proc leaves the 'set print max-depth' set to 'unlimited'.
2034 proc gdb_print_expr_at_depths {exp outputs} {
2035 for { set depth 0 } { $depth <= [llength $outputs] } { incr depth } {
2036 if { $depth == [llength $outputs] } {
2037 set expected_result [lindex $outputs [expr [llength $outputs] - 1]]
2038 set depth_string "unlimited"
2040 set expected_result [lindex $outputs $depth]
2041 set depth_string $depth
2044 with_test_prefix "exp='$exp': depth=${depth_string}" {
2045 gdb_test_no_output "set print max-depth ${depth_string}"
2046 gdb_test "p $exp" "$expected_result"
2053 # Issue a PASS and return true if evaluating CONDITION in the caller's
2054 # frame returns true, and issue a FAIL and return false otherwise.
2055 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
2056 # omitted or is empty, then the pass/fail messages use the condition
2057 # string as the message.
2059 proc gdb_assert { condition {message ""} } {
2060 if { $message == ""} {
2061 set message $condition
2064 set code [catch {uplevel 1 [list expr $condition]} res]
2066 # If code is 1 (TCL_ERROR), it means evaluation failed and res contains
2067 # an error message. Print the error message, and set res to 0 since we
2068 # want to return a boolean.
2069 warning "While evaluating expression in gdb_assert: $res"
2072 } elseif { !$res } {
2080 proc gdb_reinitialize_dir { subdir } {
2083 if [is_remote host] {
2088 -re "Reinitialize source path to empty.*y or n. " {
2089 send_gdb "y\n" answer
2091 -re "Source directories searched.*$gdb_prompt $" {
2092 send_gdb "dir $subdir\n"
2094 -re "Source directories searched.*$gdb_prompt $" {
2095 verbose "Dir set to $subdir"
2097 -re "$gdb_prompt $" {
2098 perror "Dir \"$subdir\" failed."
2102 -re "$gdb_prompt $" {
2103 perror "Dir \"$subdir\" failed."
2107 -re "$gdb_prompt $" {
2108 perror "Dir \"$subdir\" failed."
2114 # gdb_exit -- exit the GDB, killing the target program if necessary
2116 proc default_gdb_exit {} {
2118 global INTERNAL_GDBFLAGS GDBFLAGS
2119 global gdb_spawn_id inferior_spawn_id
2120 global inotify_log_file
2122 if ![info exists gdb_spawn_id] {
2126 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
2128 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
2129 set fd [open $inotify_log_file]
2130 set data [read -nonewline $fd]
2133 if {[string compare $data ""] != 0} {
2134 warning "parallel-unsafe file creations noticed"
2137 set fd [open $inotify_log_file w]
2142 if { [is_remote host] && [board_info host exists fileid] } {
2146 send_gdb "y\n" answer
2149 -re "DOSEXIT code" { }
2154 if ![is_remote host] {
2158 unset ::gdb_tty_name
2159 unset inferior_spawn_id
2162 # Load a file into the debugger.
2163 # The return value is 0 for success, -1 for failure.
2165 # ARG is the file name.
2166 # KILL_FLAG, if given, indicates whether a "kill" command should be used.
2168 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
2169 # to one of these values:
2171 # debug file was loaded successfully and has debug information
2172 # nodebug file was loaded successfully and has no debug information
2173 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
2175 # fail file was not loaded
2177 # This procedure also set the global variable GDB_FILE_CMD_MSG to the
2178 # output of the file command in case of success.
2180 # I tried returning this information as part of the return value,
2181 # but ran into a mess because of the many re-implementations of
2182 # gdb_load in config/*.exp.
2184 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
2185 # this if they can get more information set.
2187 proc gdb_file_cmd { arg {kill_flag 1} } {
2190 global last_loaded_file
2192 # GCC for Windows target may create foo.exe given "-o foo".
2193 if { ![file exists $arg] && [file exists "$arg.exe"] } {
2197 # Save this for the benefit of gdbserver-support.exp.
2198 set last_loaded_file $arg
2200 # Set whether debug info was found.
2201 # Default to "fail".
2202 global gdb_file_cmd_debug_info gdb_file_cmd_msg
2203 set gdb_file_cmd_debug_info "fail"
2205 if [is_remote host] {
2206 set arg [remote_download host $arg]
2208 perror "download failed"
2213 # The file command used to kill the remote target. For the benefit
2214 # of the testsuite, preserve this behavior. Mark as optional so it doesn't
2215 # get written to the stdin log.
2217 send_gdb "kill\n" optional
2219 -re "Kill the program being debugged. .y or n. $" {
2220 send_gdb "y\n" answer
2221 verbose "\t\tKilling previous program being debugged"
2224 -re "$gdb_prompt $" {
2230 send_gdb "file $arg\n"
2231 set new_symbol_table 0
2232 set basename [file tail $arg]
2234 -re "(Reading symbols from.*LZMA support was disabled.*$gdb_prompt $)" {
2235 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
2236 set gdb_file_cmd_msg $expect_out(1,string)
2237 set gdb_file_cmd_debug_info "lzma"
2240 -re "(Reading symbols from.*No debugging symbols found.*$gdb_prompt $)" {
2241 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
2242 set gdb_file_cmd_msg $expect_out(1,string)
2243 set gdb_file_cmd_debug_info "nodebug"
2246 -re "(Reading symbols from.*$gdb_prompt $)" {
2247 verbose "\t\tLoaded $arg into $GDB"
2248 set gdb_file_cmd_msg $expect_out(1,string)
2249 set gdb_file_cmd_debug_info "debug"
2252 -re "Load new symbol table from \".*\".*y or n. $" {
2253 if { $new_symbol_table > 0 } {
2254 perror [join [list "Couldn't load $basename,"
2255 "interactive prompt loop detected."]]
2258 send_gdb "y\n" answer
2259 incr new_symbol_table
2260 set suffix "-- with new symbol table"
2261 set arg "$arg $suffix"
2262 set basename "$basename $suffix"
2265 -re "No such file or directory.*$gdb_prompt $" {
2266 perror "($basename) No such file or directory"
2269 -re "A problem internal to GDB has been detected" {
2270 perror "Couldn't load $basename into GDB (GDB internal error)."
2271 gdb_internal_error_resync
2274 -re "$gdb_prompt $" {
2275 perror "Couldn't load $basename into GDB."
2279 perror "Couldn't load $basename into GDB (timeout)."
2283 # This is an attempt to detect a core dump, but seems not to
2284 # work. Perhaps we need to match .* followed by eof, in which
2285 # gdb_expect does not seem to have a way to do that.
2286 perror "Couldn't load $basename into GDB (eof)."
2292 # The expect "spawn" function puts the tty name into the spawn_out
2293 # array; but dejagnu doesn't export this globally. So, we have to
2294 # wrap spawn with our own function and poke in the built-in spawn
2295 # so that we can capture this value.
2297 # If available, the TTY name is saved to the LAST_SPAWN_TTY_NAME global.
2298 # Otherwise, LAST_SPAWN_TTY_NAME is unset.
2300 proc spawn_capture_tty_name { args } {
2301 set result [uplevel builtin_spawn $args]
2302 upvar spawn_out spawn_out
2303 if { [info exists spawn_out(slave,name)] } {
2304 set ::last_spawn_tty_name $spawn_out(slave,name)
2306 # If a process is spawned as part of a pipe line (e.g. passing
2307 # -leaveopen to the spawn proc) then the spawned process is no
2308 # assigned a tty and spawn_out(slave,name) will not be set.
2309 # In that case we want to ensure that last_spawn_tty_name is
2312 # If the previous process spawned was also not assigned a tty
2313 # (e.g. multiple processed chained in a pipeline) then
2314 # last_spawn_tty_name will already be unset, so, if we don't
2315 # use -nocomplain here we would otherwise get an error.
2316 unset -nocomplain ::last_spawn_tty_name
2321 rename spawn builtin_spawn
2322 rename spawn_capture_tty_name spawn
2324 # Default gdb_spawn procedure.
2326 proc default_gdb_spawn { } {
2329 global INTERNAL_GDBFLAGS GDBFLAGS
2332 # Set the default value, it may be overriden later by specific testfile.
2334 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
2335 # is already started after connecting and run/attach are not supported.
2336 # This is used for the "remote" protocol. After GDB starts you should
2337 # check global $use_gdb_stub instead of the board as the testfile may force
2338 # a specific different target protocol itself.
2339 set use_gdb_stub [target_info exists use_gdb_stub]
2341 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
2342 gdb_write_cmd_file "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
2344 if [info exists gdb_spawn_id] {
2348 if ![is_remote host] {
2349 if {[which $GDB] == 0} {
2350 perror "$GDB does not exist."
2355 # Put GDBFLAGS last so that tests can put "--args ..." in it.
2356 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS [host_info gdb_opts] $GDBFLAGS"]
2357 if { $res < 0 || $res == "" } {
2358 perror "Spawning $GDB failed."
2362 set gdb_spawn_id $res
2363 set ::gdb_tty_name $::last_spawn_tty_name
2367 # Default gdb_start procedure.
2369 proc default_gdb_start { } {
2372 global inferior_spawn_id
2374 if [info exists gdb_spawn_id] {
2378 # Keep track of the number of times GDB has been launched.
2379 global gdb_instances
2389 # Default to assuming inferior I/O is done on GDB's terminal.
2390 if {![info exists inferior_spawn_id]} {
2391 set inferior_spawn_id $gdb_spawn_id
2394 # When running over NFS, particularly if running many simultaneous
2395 # tests on different hosts all using the same server, things can
2396 # get really slow. Give gdb at least 3 minutes to start up.
2398 -re "\[\r\n\]$gdb_prompt $" {
2399 verbose "GDB initialized."
2401 -re "\[\r\n\]\033\\\[.2004h$gdb_prompt $" {
2402 # This special case detects what happens when GDB is
2403 # started with bracketed paste mode enabled. This mode is
2404 # usually forced off (see setting of INPUTRC in
2405 # default_gdb_init), but for at least one test we turn
2406 # bracketed paste mode back on, and then start GDB. In
2407 # that case, this case is hit.
2408 verbose "GDB initialized."
2410 -re "^$gdb_prompt $" {
2412 verbose "GDB initialized."
2414 -re "^\033\\\[.2004h$gdb_prompt $" {
2415 # Output with -q, and bracketed paste mode enabled, see above.
2416 verbose "GDB initialized."
2418 -re "$gdb_prompt $" {
2419 perror "GDB never initialized."
2424 perror "(timeout) GDB never initialized after 10 seconds."
2430 perror "(eof) GDB never initialized."
2436 # force the height to "unlimited", so no pagers get used
2438 send_gdb "set height 0\n"
2440 -re "$gdb_prompt $" {
2441 verbose "Setting height to 0." 2
2444 warning "Couldn't set the height to 0"
2447 # force the width to "unlimited", so no wraparound occurs
2448 send_gdb "set width 0\n"
2450 -re "$gdb_prompt $" {
2451 verbose "Setting width to 0." 2
2454 warning "Couldn't set the width to 0."
2462 # Utility procedure to give user control of the gdb prompt in a script. It is
2463 # meant to be used for debugging test cases, and should not be left in the
2466 proc gdb_interact { } {
2468 set spawn_id $gdb_spawn_id
2470 send_user "+------------------------------------------+\n"
2471 send_user "| Script interrupted, you can now interact |\n"
2472 send_user "| with by gdb. Type >>> to continue. |\n"
2473 send_user "+------------------------------------------+\n"
2480 # Examine the output of compilation to determine whether compilation
2481 # failed or not. If it failed determine whether it is due to missing
2482 # compiler or due to compiler error. Report pass, fail or unsupported
2485 proc gdb_compile_test {src output} {
2486 set msg "compilation [file tail $src]"
2488 if { $output == "" } {
2493 if { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output]
2494 || [regexp {.*: command not found[\r|\n]*$} $output]
2495 || [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
2496 unsupported "$msg (missing compiler)"
2500 set gcc_re ".*: error: unrecognized command line option "
2501 set clang_re ".*: error: unsupported option "
2502 if { [regexp "(?:$gcc_re|$clang_re)(\[^ \t;\r\n\]*)" $output dummy option]
2503 && $option != "" } {
2504 unsupported "$msg (unsupported option $option)"
2508 # Unclassified compilation failure, be more verbose.
2509 verbose -log "compilation failed: $output" 2
2513 # Return a 1 for configurations for which we want to try to test C++.
2515 proc allow_cplus_tests {} {
2516 if { [istarget "h8300-*-*"] } {
2520 # The C++ IO streams are too large for HC11/HC12 and are thus not
2521 # available. The gdb C++ tests use them and don't compile.
2522 if { [istarget "m6811-*-*"] } {
2525 if { [istarget "m6812-*-*"] } {
2531 # Return a 0 for configurations which are missing either C++ or the STL.
2533 proc allow_stl_tests {} {
2534 return [allow_cplus_tests]
2537 # Return a 1 if I want to try to test FORTRAN.
2539 proc allow_fortran_tests {} {
2543 # Return a 1 if I want to try to test ada.
2545 proc allow_ada_tests {} {
2546 if { [is_remote host] } {
2547 # Currently gdb_ada_compile doesn't support remote host.
2553 # Return a 1 if I want to try to test GO.
2555 proc allow_go_tests {} {
2559 # Return a 1 if I even want to try to test D.
2561 proc allow_d_tests {} {
2565 # Return a 1 if we can compile source files in LANG.
2567 gdb_caching_proc can_compile { lang } {
2569 if { $lang == "d" } {
2570 set src { void main() {} }
2571 return [gdb_can_simple_compile can_compile_$lang $src executable {d}]
2574 if { $lang == "rust" } {
2575 if { ![isnative] } {
2579 if { [is_remote host] } {
2580 # Proc find_rustc returns "" for remote host.
2584 # The rust compiler does not support "-m32", skip.
2585 global board board_info
2586 set board [target_info name]
2587 if {[board_info $board exists multilib_flags]} {
2588 foreach flag [board_info $board multilib_flags] {
2589 if { $flag == "-m32" } {
2595 set src { fn main() {} }
2596 # Drop nowarnings in default_compile_flags, it translates to -w which
2597 # rustc doesn't support.
2598 return [gdb_can_simple_compile can_compile_$lang $src executable \
2599 {rust} {debug quiet}]
2602 error "can_compile doesn't support lang: $lang"
2605 # Return 1 to try Rust tests, 0 to skip them.
2606 proc allow_rust_tests {} {
2610 # Return a 1 for configurations that support Python scripting.
2612 gdb_caching_proc allow_python_tests {} {
2613 set output [remote_exec host $::GDB "$::INTERNAL_GDBFLAGS --configuration"]
2614 return [expr {[string first "--with-python" $output] != -1}]
2617 # Return a 1 for configurations that use system readline rather than the
2620 gdb_caching_proc with_system_readline {} {
2621 set output [remote_exec host $::GDB "$::INTERNAL_GDBFLAGS --configuration"]
2622 return [expr {[string first "--with-system-readline" $output] != -1}]
2625 gdb_caching_proc allow_dap_tests {} {
2626 if { ![allow_python_tests] } {
2630 # The dap code uses module typing, available starting python 3.5.
2631 if { ![python_version_at_least 3 5] } {
2635 # ton.tcl uses "string is entier", supported starting tcl 8.6.
2636 if { ![tcl_version_at_least 8 6] } {
2640 # With set auto-connect-native-target off, we run into:
2642 # Traceback (most recent call last):
2643 # File "startup.py", line <n>, in exec_and_log
2644 # output = gdb.execute(cmd, from_tty=True, to_string=True)
2645 # gdb.error: Don't know how to run. Try "help target".
2646 set gdb_flags [join $::GDBFLAGS $::INTERNAL_GDBFLAGS]
2647 return [expr {[string first "set auto-connect-native-target off" $gdb_flags] == -1}]
2650 # Return a 1 if we should run shared library tests.
2652 proc allow_shlib_tests {} {
2653 # Run the shared library tests on native systems.
2658 # An abbreviated list of remote targets where we should be able to
2659 # run shared library tests.
2660 if {([istarget *-*-linux*]
2661 || [istarget *-*-*bsd*]
2662 || [istarget *-*-solaris2*]
2663 || [istarget *-*-mingw*]
2664 || [istarget *-*-cygwin*]
2665 || [istarget *-*-pe*])} {
2672 # Return 1 if we should run dlmopen tests, 0 if we should not.
2674 gdb_caching_proc allow_dlmopen_tests {} {
2675 global srcdir subdir gdb_prompt inferior_exited_re
2677 # We need shared library support.
2678 if { ![allow_shlib_tests] } {
2682 set me "allow_dlmopen_tests"
2696 struct r_debug *r_debug;
2700 /* The version is kept at 1 until we create a new namespace. */
2701 handle = dlmopen (LM_ID_NEWLM, DSO_NAME, RTLD_LAZY | RTLD_LOCAL);
2703 printf ("dlmopen failed: %s.\n", dlerror ());
2708 /* Taken from /usr/include/link.h. */
2709 for (dyn = _DYNAMIC; dyn->d_tag != DT_NULL; ++dyn)
2710 if (dyn->d_tag == DT_DEBUG)
2711 r_debug = (struct r_debug *) dyn->d_un.d_ptr;
2714 printf ("r_debug not found.\n");
2717 if (r_debug->r_version < 2) {
2718 printf ("dlmopen debug not supported.\n");
2721 printf ("dlmopen debug supported.\n");
2726 set libsrc [standard_temp_file "libfoo.c"]
2727 set libout [standard_temp_file "libfoo.so"]
2728 gdb_produce_source $libsrc $lib
2730 if { [gdb_compile_shlib $libsrc $libout {debug}] != "" } {
2731 verbose -log "failed to build library"
2734 if { ![gdb_simple_compile $me $src executable \
2735 [list shlib_load debug \
2736 additional_flags=-DDSO_NAME=\"$libout\"]] } {
2737 verbose -log "failed to build executable"
2743 gdb_reinitialize_dir $srcdir/$subdir
2746 if { [gdb_run_cmd] != 0 } {
2747 verbose -log "failed to start skip test"
2751 -re "$inferior_exited_re normally.*${gdb_prompt} $" {
2752 set allow_dlmopen_tests 1
2754 -re "$inferior_exited_re with code.*${gdb_prompt} $" {
2755 set allow_dlmopen_tests 0
2758 warning "\n$me: default case taken"
2759 set allow_dlmopen_tests 0
2764 verbose "$me: returning $allow_dlmopen_tests" 2
2765 return $allow_dlmopen_tests
2768 # Return 1 if we should allow TUI-related tests.
2770 gdb_caching_proc allow_tui_tests {} {
2771 set output [remote_exec host $::GDB "$::INTERNAL_GDBFLAGS --configuration"]
2772 return [expr {[string first "--enable-tui" $output] != -1}]
2775 # Test files shall make sure all the test result lines in gdb.sum are
2776 # unique in a test run, so that comparing the gdb.sum files of two
2777 # test runs gives correct results. Test files that exercise
2778 # variations of the same tests more than once, shall prefix the
2779 # different test invocations with different identifying strings in
2780 # order to make them unique.
2782 # About test prefixes:
2784 # $pf_prefix is the string that dejagnu prints after the result (FAIL,
2785 # PASS, etc.), and before the test message/name in gdb.sum. E.g., the
2786 # underlined substring in
2788 # PASS: gdb.base/mytest.exp: some test
2789 # ^^^^^^^^^^^^^^^^^^^^
2793 # The easiest way to adjust the test prefix is to append a test
2794 # variation prefix to the $pf_prefix, using the with_test_prefix
2797 # proc do_tests {} {
2798 # gdb_test ... ... "test foo"
2799 # gdb_test ... ... "test bar"
2801 # with_test_prefix "subvariation a" {
2802 # gdb_test ... ... "test x"
2805 # with_test_prefix "subvariation b" {
2806 # gdb_test ... ... "test x"
2810 # with_test_prefix "variation1" {
2811 # ...do setup for variation 1...
2815 # with_test_prefix "variation2" {
2816 # ...do setup for variation 2...
2822 # PASS: gdb.base/mytest.exp: variation1: test foo
2823 # PASS: gdb.base/mytest.exp: variation1: test bar
2824 # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
2825 # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
2826 # PASS: gdb.base/mytest.exp: variation2: test foo
2827 # PASS: gdb.base/mytest.exp: variation2: test bar
2828 # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
2829 # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
2831 # If for some reason more flexibility is necessary, one can also
2832 # manipulate the pf_prefix global directly, treating it as a string.
2836 # set saved_pf_prefix
2837 # append pf_prefix "${foo}: bar"
2838 # ... actual tests ...
2839 # set pf_prefix $saved_pf_prefix
2842 # Run BODY in the context of the caller, with the current test prefix
2843 # (pf_prefix) appended with one space, then PREFIX, and then a colon.
2844 # Returns the result of BODY.
2846 proc with_test_prefix { prefix body } {
2849 set saved $pf_prefix
2850 append pf_prefix " " $prefix ":"
2851 set code [catch {uplevel 1 $body} result]
2852 set pf_prefix $saved
2855 global errorInfo errorCode
2856 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2858 return -code $code $result
2862 # Wrapper for foreach that calls with_test_prefix on each iteration,
2863 # including the iterator's name and current value in the prefix.
2865 proc foreach_with_prefix {var list body} {
2867 foreach myvar $list {
2868 with_test_prefix "$var=$myvar" {
2869 set code [catch {uplevel 1 $body} result]
2873 global errorInfo errorCode
2874 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2875 } elseif {$code == 3} {
2877 } elseif {$code == 2} {
2878 return -code $code $result
2883 # Like TCL's native proc, but defines a procedure that wraps its body
2884 # within 'with_test_prefix "$proc_name" { ... }'.
2885 proc proc_with_prefix {name arguments body} {
2886 # Define the advertised proc.
2887 proc $name $arguments [list with_test_prefix $name $body]
2890 # Return an id corresponding to the test prefix stored in $pf_prefix, which
2891 # is more suitable for use in a file name.
2892 # F.i., for a pf_prefix:
2893 # gdb.dwarf2/dw2-lines.exp: \
2894 # cv=5: cdw=64: lv=5: ldw=64: string_form=line_strp:
2896 # cv-5-cdw-32-lv-5-ldw-64-string_form-line_strp
2902 # Strip ".exp: " prefix.
2903 set id [regsub {.*\.exp: } $id {}]
2905 # Strip colon suffix.
2906 set id [regsub {:$} $id {}]
2909 set id [regsub -all { } $id {}]
2911 # Replace colons, equal signs.
2912 set id [regsub -all \[:=\] $id -]
2917 # Run BODY in the context of the caller. After BODY is run, the variables
2918 # listed in VARS will be reset to the values they had before BODY was run.
2920 # This is useful for providing a scope in which it is safe to temporarily
2921 # modify global variables, e.g.
2923 # global INTERNAL_GDBFLAGS
2926 # set foo GDBHISTSIZE
2928 # save_vars { INTERNAL_GDBFLAGS env($foo) env(HOME) } {
2929 # append INTERNAL_GDBFLAGS " -nx"
2930 # unset -nocomplain env(GDBHISTSIZE)
2935 # Here, although INTERNAL_GDBFLAGS, env(GDBHISTSIZE) and env(HOME) may be
2936 # modified inside BODY, this proc guarantees that the modifications will be
2937 # undone after BODY finishes executing.
2939 proc save_vars { vars body } {
2940 array set saved_scalars { }
2941 array set saved_arrays { }
2945 # First evaluate VAR in the context of the caller in case the variable
2946 # name may be a not-yet-interpolated string like env($foo)
2947 set var [uplevel 1 list $var]
2949 if [uplevel 1 [list info exists $var]] {
2950 if [uplevel 1 [list array exists $var]] {
2951 set saved_arrays($var) [uplevel 1 [list array get $var]]
2953 set saved_scalars($var) [uplevel 1 [list set $var]]
2956 lappend unset_vars $var
2960 set code [catch {uplevel 1 $body} result]
2962 foreach {var value} [array get saved_scalars] {
2963 uplevel 1 [list set $var $value]
2966 foreach {var value} [array get saved_arrays] {
2967 uplevel 1 [list unset $var]
2968 uplevel 1 [list array set $var $value]
2971 foreach var $unset_vars {
2972 uplevel 1 [list unset -nocomplain $var]
2976 global errorInfo errorCode
2977 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2979 return -code $code $result
2983 # As save_vars, but for variables stored in the board_info for the
2988 # save_target_board_info { multilib_flags } {
2990 # set board [target_info name]
2991 # unset_board_info multilib_flags
2992 # set_board_info multilib_flags "$multilib_flags"
2996 proc save_target_board_info { vars body } {
2997 global board board_info
2998 set board [target_info name]
3000 array set saved_target_board_info { }
3001 set unset_target_board_info { }
3004 if { [info exists board_info($board,$var)] } {
3005 set saved_target_board_info($var) [board_info $board $var]
3007 lappend unset_target_board_info $var
3011 set code [catch {uplevel 1 $body} result]
3013 foreach {var value} [array get saved_target_board_info] {
3014 unset_board_info $var
3015 set_board_info $var $value
3018 foreach var $unset_target_board_info {
3019 unset_board_info $var
3023 global errorInfo errorCode
3024 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3026 return -code $code $result
3030 # Run tests in BODY with the current working directory (CWD) set to
3031 # DIR. When BODY is finished, restore the original CWD. Return the
3034 # This procedure doesn't check if DIR is a valid directory, so you
3035 # have to make sure of that.
3037 proc with_cwd { dir body } {
3039 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
3042 set code [catch {uplevel 1 $body} result]
3044 verbose -log "Switching back to $saved_dir."
3048 global errorInfo errorCode
3049 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3051 return -code $code $result
3055 # Use GDB's 'cd' command to switch to DIR. Return true if the switch
3056 # was successful, otherwise, call perror and return false.
3058 proc gdb_cd { dir } {
3060 gdb_test_multiple "cd $dir" "" {
3061 -re "^cd \[^\r\n\]+\r\n" {
3065 -re "^Working directory (\[^\r\n\]+)\\.\r\n" {
3066 set new_dir $expect_out(1,string)
3070 -re "^$::gdb_prompt $" {
3071 if { $new_dir == "" || $new_dir != $dir } {
3072 perror "failed to switch to $dir"
3081 # Use GDB's 'pwd' command to figure out the current working directory.
3082 # Return the directory as a string. If we can't figure out the
3083 # current working directory, then call perror, and return the empty
3088 gdb_test_multiple "pwd" "" {
3093 -re "^Working directory (\[^\r\n\]+)\\.\r\n" {
3094 set dir $expect_out(1,string)
3098 -re "^$::gdb_prompt $" {
3103 perror "failed to read GDB's current working directory"
3109 # Similar to the with_cwd proc, this proc runs BODY with the current
3110 # working directory changed to CWD.
3112 # Unlike with_cwd, the directory change here is done within GDB
3113 # itself, so GDB must be running before this proc is called.
3115 proc with_gdb_cwd { dir body } {
3116 set saved_dir [gdb_pwd]
3117 if { $saved_dir == "" } {
3121 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
3126 set code [catch {uplevel 1 $body} result]
3128 verbose -log "Switching back to $saved_dir."
3129 if ![gdb_cd $saved_dir] {
3133 # Check that GDB is still alive. If GDB crashed in the above code
3134 # then any corefile will have been left in DIR, not the root
3135 # testsuite directory. As a result the corefile will not be
3136 # brought to the users attention. Instead, if GDB crashed, then
3137 # this check should cause a FAIL, which should be enough to alert
3139 set saw_result false
3140 gdb_test_multiple "p 123" "" {
3145 -re "^\\\$$::decimal = 123\r\n" {
3150 -re "^$::gdb_prompt $" {
3151 if { !$saw_result } {
3152 fail "check gdb is alive in with_gdb_cwd"
3158 global errorInfo errorCode
3159 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3161 return -code $code $result
3165 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
3166 # PROMPT. When BODY is finished, restore GDB prompt and variable
3168 # Returns the result of BODY.
3172 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
3173 # as "(foo)", and not the regexp form "\(foo\)" (expressed as "\\(foo\\)" in
3174 # TCL). PROMPT is internally converted to a suitable regexp for matching.
3175 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
3176 # a) It's more intuitive for callers to pass the plain text form.
3177 # b) We need two forms of the prompt:
3178 # - a regexp to use in output matching,
3179 # - a value to pass to the "set prompt" command.
3180 # c) It's easier to convert the plain text form to its regexp form.
3182 # 2) Don't add a trailing space, we do that here.
3184 proc with_gdb_prompt { prompt body } {
3187 # Convert "(foo)" to "\(foo\)".
3188 # We don't use string_to_regexp because while it works today it's not
3189 # clear it will work tomorrow: the value we need must work as both a
3190 # regexp *and* as the argument to the "set prompt" command, at least until
3191 # we start recording both forms separately instead of just $gdb_prompt.
3192 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
3194 regsub -all {[]*+.|()^$\[\\]} $prompt {\\&} prompt
3196 set saved $gdb_prompt
3198 verbose -log "Setting gdb prompt to \"$prompt \"."
3199 set gdb_prompt $prompt
3200 gdb_test_no_output "set prompt $prompt " ""
3202 set code [catch {uplevel 1 $body} result]
3204 verbose -log "Restoring gdb prompt to \"$saved \"."
3205 set gdb_prompt $saved
3206 gdb_test_no_output "set prompt $saved " ""
3209 global errorInfo errorCode
3210 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3212 return -code $code $result
3216 # Run tests in BODY with target-charset setting to TARGET_CHARSET. When
3217 # BODY is finished, restore target-charset.
3219 proc with_target_charset { target_charset body } {
3223 gdb_test_multiple "show target-charset" "" {
3224 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
3225 set saved $expect_out(1,string)
3227 -re "The target character set is \"(.*)\".*$gdb_prompt " {
3228 set saved $expect_out(1,string)
3230 -re ".*$gdb_prompt " {
3231 fail "get target-charset"
3235 gdb_test_no_output -nopass "set target-charset $target_charset"
3237 set code [catch {uplevel 1 $body} result]
3239 gdb_test_no_output -nopass "set target-charset $saved"
3242 global errorInfo errorCode
3243 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3245 return -code $code $result
3249 # Run tests in BODY with max-value-size set to SIZE. When BODY is
3250 # finished restore max-value-size.
3252 proc with_max_value_size { size body } {
3256 gdb_test_multiple "show max-value-size" "" {
3257 -re -wrap "Maximum value size is ($::decimal) bytes\\." {
3258 set saved $expect_out(1,string)
3260 -re ".*$gdb_prompt " {
3261 fail "get max-value-size"
3265 gdb_test_no_output -nopass "set max-value-size $size"
3267 set code [catch {uplevel 1 $body} result]
3269 gdb_test_no_output -nopass "set max-value-size $saved"
3272 global errorInfo errorCode
3273 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3275 return -code $code $result
3279 # Switch the default spawn id to SPAWN_ID, so that gdb_test,
3280 # mi_gdb_test etc. default to using it.
3282 proc switch_gdb_spawn_id {spawn_id} {
3284 global board board_info
3286 set gdb_spawn_id $spawn_id
3287 set board [host_info name]
3288 set board_info($board,fileid) $spawn_id
3291 # Clear the default spawn id.
3293 proc clear_gdb_spawn_id {} {
3295 global board board_info
3297 unset -nocomplain gdb_spawn_id
3298 set board [host_info name]
3299 unset -nocomplain board_info($board,fileid)
3302 # Run BODY with SPAWN_ID as current spawn id.
3304 proc with_spawn_id { spawn_id body } {
3307 if [info exists gdb_spawn_id] {
3308 set saved_spawn_id $gdb_spawn_id
3311 switch_gdb_spawn_id $spawn_id
3313 set code [catch {uplevel 1 $body} result]
3315 if [info exists saved_spawn_id] {
3316 switch_gdb_spawn_id $saved_spawn_id
3322 global errorInfo errorCode
3323 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3325 return -code $code $result
3329 # DejaGNU records spawn ids in a global array and tries to wait for
3330 # them when exiting. Sometimes this caused problems if gdb's test
3331 # suite has already waited for the particular spawn id. And, dejagnu
3332 # only seems to allow a single spawn id per "machine". This proc can
3333 # be used to clean up after a spawn id has been closed.
3334 proc clean_up_spawn_id {host id} {
3336 set name [board_info $host name]
3337 if {[info exists board_info($name,fileid)]
3338 && $board_info($name,fileid) == $id} {
3339 unset -nocomplain board_info($name,fileid)
3343 # Select the largest timeout from all the timeouts:
3344 # - the local "timeout" variable of the scope two levels above,
3345 # - the global "timeout" variable,
3346 # - the board variable "gdb,timeout".
3348 proc get_largest_timeout {} {
3349 upvar #0 timeout gtimeout
3350 upvar 2 timeout timeout
3353 if [info exists timeout] {
3356 if { [info exists gtimeout] && $gtimeout > $tmt } {
3359 if { [target_info exists gdb,timeout]
3360 && [target_info gdb,timeout] > $tmt } {
3361 set tmt [target_info gdb,timeout]
3371 # Run tests in BODY with timeout increased by factor of FACTOR. When
3372 # BODY is finished, restore timeout.
3374 proc with_timeout_factor { factor body } {
3377 set savedtimeout $timeout
3379 set timeout [expr [get_largest_timeout] * $factor]
3380 set code [catch {uplevel 1 $body} result]
3382 set timeout $savedtimeout
3384 global errorInfo errorCode
3385 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
3387 return -code $code $result
3391 # Run BODY with timeout factor FACTOR if check-read1 is used.
3393 proc with_read1_timeout_factor { factor body } {
3394 if { [info exists ::env(READ1)] == 1 && $::env(READ1) == 1 } {
3395 # Use timeout factor
3397 # Reset timeout factor
3400 return [uplevel [list with_timeout_factor $factor $body]]
3403 # Return 1 if _Complex types are supported, otherwise, return 0.
3405 gdb_caching_proc support_complex_tests {} {
3407 if { ![allow_float_test] } {
3408 # If floating point is not supported, _Complex is not
3413 # Compile a test program containing _Complex types.
3415 return [gdb_can_simple_compile complex {
3419 _Complex long double cld;
3425 # Return 1 if compiling go is supported.
3426 gdb_caching_proc support_go_compile {} {
3428 return [gdb_can_simple_compile go-hello {
3432 fmt.Println("hello world")
3437 # Return 1 if GDB can get a type for siginfo from the target, otherwise
3440 proc supports_get_siginfo_type {} {
3441 if { [istarget "*-*-linux*"] } {
3448 # Return 1 if memory tagging is supported at runtime, otherwise return 0.
3450 gdb_caching_proc supports_memtag {} {
3453 gdb_test_multiple "memory-tag check" "" {
3454 -re "Memory tagging not supported or disabled by the current architecture\..*$gdb_prompt $" {
3457 -re "Argument required \\(address or pointer\\).*$gdb_prompt $" {
3464 # Return 1 if the target supports hardware single stepping.
3466 proc can_hardware_single_step {} {
3468 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
3469 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
3470 || [istarget "nios2-*-*"] || [istarget "riscv*-*-linux*"] } {
3477 # Return 1 if target hardware or OS supports single stepping to signal
3478 # handler, otherwise, return 0.
3480 proc can_single_step_to_signal_handler {} {
3481 # Targets don't have hardware single step. On these targets, when
3482 # a signal is delivered during software single step, gdb is unable
3483 # to determine the next instruction addresses, because start of signal
3484 # handler is one of them.
3485 return [can_hardware_single_step]
3488 # Return 1 if target supports process record, otherwise return 0.
3490 proc supports_process_record {} {
3492 if [target_info exists gdb,use_precord] {
3493 return [target_info gdb,use_precord]
3496 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
3497 || [istarget "i\[34567\]86-*-linux*"]
3498 || [istarget "aarch64*-*-linux*"]
3499 || [istarget "powerpc*-*-linux*"]
3500 || [istarget "s390*-*-linux*"] } {
3507 # Return 1 if target supports reverse debugging, otherwise return 0.
3509 proc supports_reverse {} {
3511 if [target_info exists gdb,can_reverse] {
3512 return [target_info gdb,can_reverse]
3515 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
3516 || [istarget "i\[34567\]86-*-linux*"]
3517 || [istarget "aarch64*-*-linux*"]
3518 || [istarget "powerpc*-*-linux*"]
3519 || [istarget "s390*-*-linux*"] } {
3526 # Return 1 if readline library is used.
3528 proc readline_is_used { } {
3531 gdb_test_multiple "show editing" "" {
3532 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
3535 -re ".*$gdb_prompt $" {
3541 # Return 1 if target is ELF.
3542 gdb_caching_proc is_elf_target {} {
3543 set me "is_elf_target"
3545 set src { int foo () {return 0;} }
3546 if {![gdb_simple_compile elf_target $src]} {
3550 set fp_obj [open $obj "r"]
3551 fconfigure $fp_obj -translation binary
3552 set data [read $fp_obj]
3557 set ELFMAG "\u007FELF"
3559 if {[string compare -length 4 $data $ELFMAG] != 0} {
3560 verbose "$me: returning 0" 2
3564 verbose "$me: returning 1" 2
3568 # Return 1 if the memory at address zero is readable.
3570 gdb_caching_proc is_address_zero_readable {} {
3574 gdb_test_multiple "x 0" "" {
3575 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
3578 -re ".*$gdb_prompt $" {
3586 # Produce source file NAME and write SOURCES into it.
3588 proc gdb_produce_source { name sources } {
3590 set f [open $name "w"]
3596 # Return 1 if target is ILP32.
3597 # This cannot be decided simply from looking at the target string,
3598 # as it might depend on externally passed compiler options like -m64.
3599 gdb_caching_proc is_ilp32_target {} {
3600 return [gdb_can_simple_compile is_ilp32_target {
3601 int dummy[sizeof (int) == 4
3602 && sizeof (void *) == 4
3603 && sizeof (long) == 4 ? 1 : -1];
3607 # Return 1 if target is LP64.
3608 # This cannot be decided simply from looking at the target string,
3609 # as it might depend on externally passed compiler options like -m64.
3610 gdb_caching_proc is_lp64_target {} {
3611 return [gdb_can_simple_compile is_lp64_target {
3612 int dummy[sizeof (int) == 4
3613 && sizeof (void *) == 8
3614 && sizeof (long) == 8 ? 1 : -1];
3618 # Return 1 if target has 64 bit addresses.
3619 # This cannot be decided simply from looking at the target string,
3620 # as it might depend on externally passed compiler options like -m64.
3621 gdb_caching_proc is_64_target {} {
3622 return [gdb_can_simple_compile_nodebug is_64_target {
3623 int function(void) { return 3; }
3624 int dummy[sizeof (&function) == 8 ? 1 : -1];
3628 # Return 1 if target has x86_64 registers - either amd64 or x32.
3629 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
3630 # just from the target string.
3631 gdb_caching_proc is_amd64_regs_target {} {
3632 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
3636 return [gdb_can_simple_compile is_amd64_regs_target {
3646 # Return 1 if this target is an x86 or x86-64 with -m32.
3647 proc is_x86_like_target {} {
3648 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
3651 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
3654 # Return 1 if this target is an x86_64 with -m64.
3655 proc is_x86_64_m64_target {} {
3656 return [expr [istarget x86_64-*-* ] && [is_lp64_target]]
3659 # Return 1 if this target is an arm or aarch32 on aarch64.
3661 gdb_caching_proc is_aarch32_target {} {
3662 if { [istarget "arm*-*-*"] } {
3666 if { ![istarget "aarch64*-*-*"] } {
3673 lappend list "\tmov $reg, $reg"
3676 return [gdb_can_simple_compile aarch32 [join $list \n]]
3679 # Return 1 if this target is an aarch64, either lp64 or ilp32.
3681 proc is_aarch64_target {} {
3682 if { ![istarget "aarch64*-*-*"] } {
3686 return [expr ![is_aarch32_target]]
3689 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
3690 proc support_displaced_stepping {} {
3692 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
3693 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
3694 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
3695 || [istarget "aarch64*-*-linux*"] || [istarget "loongarch*-*-linux*"] } {
3702 # Return 0 and a reason string if GDB can determine that libc doesn't have
3703 # debug info, and 1 otherwise. This procedure is meant to be called by the
3704 # require procedure.
3705 gdb_caching_proc libc_has_debug_info {} {
3706 global srcdir subdir gdb_prompt inferior_exited_re
3708 set me "libc_has_debug_info"
3710 # Compile a test program.
3715 printf ("Hello, world!\n");
3719 if {![gdb_simple_compile $me $src executable {debug}]} {
3720 return [list 0 "failed to compile test program"]
3723 # No error message, compilation succeeded so now run it via gdb.
3727 gdb_reinitialize_dir $srcdir/$subdir
3730 set libc_has_debug_info 1
3731 set message "unable to get information on libc.so"
3732 set test "info sharedlibrary"
3733 gdb_test_multiple $test $test {
3734 -re ".*\(\\*\)\[^\r\n\]*/libc\.so.*$gdb_prompt $" {
3735 # Matched the "(*)" in the "Syms Read" columns which means:
3736 # "(*): Shared library is missing debugging information."
3737 set libc_has_debug_info 0
3738 set message "libc doesn't have debug info"
3740 -re ".*$gdb_prompt $" {
3741 # The default pattern for the GDB prompt in gdb_test_multiple
3742 # causes a FAIL if it matches, but in our case we should just
3743 # assume that there is libc debug info.
3747 remote_file build delete $obj
3749 verbose "$me: returning $libc_has_debug_info" 2
3750 if { $libc_has_debug_info } {
3751 return $libc_has_debug_info
3753 return [list $libc_has_debug_info $message]
3757 # Run a test on the target to see if it supports vmx hardware. Return 1 if so,
3758 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3760 gdb_caching_proc allow_altivec_tests {} {
3761 global srcdir subdir gdb_prompt inferior_exited_re
3763 set me "allow_altivec_tests"
3765 # Some simulators are known to not support VMX instructions.
3766 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
3767 verbose "$me: target known to not support VMX, returning 0" 2
3771 if {![istarget powerpc*]} {
3772 verbose "$me: PPC target required, returning 0" 2
3776 # Make sure we have a compiler that understands altivec.
3777 if [test_compiler_info gcc*] {
3778 set compile_flags "additional_flags=-maltivec"
3779 } elseif [test_compiler_info xlc*] {
3780 set compile_flags "additional_flags=-qaltivec"
3782 verbose "Could not compile with altivec support, returning 0" 2
3786 # Compile a test program containing VMX instructions.
3790 asm volatile ("vor v0,v0,v0");
3792 asm volatile ("vor 0,0,0");
3797 if {![gdb_simple_compile $me $src executable $compile_flags]} {
3801 # Compilation succeeded so now run it via gdb.
3805 gdb_reinitialize_dir $srcdir/$subdir
3809 -re ".*Illegal instruction.*${gdb_prompt} $" {
3810 verbose -log "\n$me altivec hardware not detected"
3811 set allow_vmx_tests 0
3813 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3814 verbose -log "\n$me: altivec hardware detected"
3815 set allow_vmx_tests 1
3818 warning "\n$me: default case taken"
3819 set allow_vmx_tests 0
3823 remote_file build delete $obj
3825 verbose "$me: returning $allow_vmx_tests" 2
3826 return $allow_vmx_tests
3829 # Run a test on the power target to see if it supports ISA 3.1 instructions
3830 gdb_caching_proc allow_power_isa_3_1_tests {} {
3831 global srcdir subdir gdb_prompt inferior_exited_re
3833 set me "allow_power_isa_3_1_tests"
3835 # Compile a test program containing ISA 3.1 instructions.
3838 asm volatile ("pnop"); // marker
3839 asm volatile ("nop");
3844 if {![gdb_simple_compile $me $src executable ]} {
3848 # No error message, compilation succeeded so now run it via gdb.
3852 gdb_reinitialize_dir $srcdir/$subdir
3856 -re ".*Illegal instruction.*${gdb_prompt} $" {
3857 verbose -log "\n$me Power ISA 3.1 hardware not detected"
3858 set allow_power_isa_3_1_tests 0
3860 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3861 verbose -log "\n$me: Power ISA 3.1 hardware detected"
3862 set allow_power_isa_3_1_tests 1
3865 warning "\n$me: default case taken"
3866 set allow_power_isa_3_1_tests 0
3870 remote_file build delete $obj
3872 verbose "$me: returning $allow_power_isa_3_1_tests" 2
3873 return $allow_power_isa_3_1_tests
3876 # Run a test on the target to see if it supports vmx hardware. Return 1 if so,
3877 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3879 gdb_caching_proc allow_vsx_tests {} {
3880 global srcdir subdir gdb_prompt inferior_exited_re
3882 set me "allow_vsx_tests"
3884 # Some simulators are known to not support Altivec instructions, so
3885 # they won't support VSX instructions as well.
3886 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
3887 verbose "$me: target known to not support VSX, returning 0" 2
3891 # Make sure we have a compiler that understands altivec.
3892 if [test_compiler_info gcc*] {
3893 set compile_flags "additional_flags=-mvsx"
3894 } elseif [test_compiler_info xlc*] {
3895 set compile_flags "additional_flags=-qasm=gcc"
3897 verbose "Could not compile with vsx support, returning 0" 2
3901 # Compile a test program containing VSX instructions.
3904 double a[2] = { 1.0, 2.0 };
3906 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
3908 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
3913 if {![gdb_simple_compile $me $src executable $compile_flags]} {
3917 # No error message, compilation succeeded so now run it via gdb.
3921 gdb_reinitialize_dir $srcdir/$subdir
3925 -re ".*Illegal instruction.*${gdb_prompt} $" {
3926 verbose -log "\n$me VSX hardware not detected"
3927 set allow_vsx_tests 0
3929 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3930 verbose -log "\n$me: VSX hardware detected"
3931 set allow_vsx_tests 1
3934 warning "\n$me: default case taken"
3935 set allow_vsx_tests 0
3939 remote_file build delete $obj
3941 verbose "$me: returning $allow_vsx_tests" 2
3942 return $allow_vsx_tests
3945 # Run a test on the target to see if it supports TSX hardware. Return 1 if so,
3946 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3948 gdb_caching_proc allow_tsx_tests {} {
3949 global srcdir subdir gdb_prompt inferior_exited_re
3951 set me "allow_tsx_tests"
3953 # Compile a test program.
3956 asm volatile ("xbegin .L0");
3957 asm volatile ("xend");
3958 asm volatile (".L0: nop");
3962 if {![gdb_simple_compile $me $src executable]} {
3966 # No error message, compilation succeeded so now run it via gdb.
3970 gdb_reinitialize_dir $srcdir/$subdir
3974 -re ".*Illegal instruction.*${gdb_prompt} $" {
3975 verbose -log "$me: TSX hardware not detected."
3976 set allow_tsx_tests 0
3978 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3979 verbose -log "$me: TSX hardware detected."
3980 set allow_tsx_tests 1
3983 warning "\n$me: default case taken."
3984 set allow_tsx_tests 0
3988 remote_file build delete $obj
3990 verbose "$me: returning $allow_tsx_tests" 2
3991 return $allow_tsx_tests
3994 # Run a test on the target to see if it supports avx512bf16. Return 1 if so,
3995 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
3997 gdb_caching_proc allow_avx512bf16_tests {} {
3998 global srcdir subdir gdb_prompt inferior_exited_re
4000 set me "allow_avx512bf16_tests"
4001 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
4002 verbose "$me: target does not support avx512bf16, returning 0" 2
4006 # Compile a test program.
4009 asm volatile ("vcvtne2ps2bf16 %xmm0, %xmm1, %xmm0");
4013 if {![gdb_simple_compile $me $src executable]} {
4017 # No error message, compilation succeeded so now run it via gdb.
4021 gdb_reinitialize_dir $srcdir/$subdir
4025 -re ".*Illegal instruction.*${gdb_prompt} $" {
4026 verbose -log "$me: avx512bf16 hardware not detected."
4027 set allow_avx512bf16_tests 0
4029 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
4030 verbose -log "$me: avx512bf16 hardware detected."
4031 set allow_avx512bf16_tests 1
4034 warning "\n$me: default case taken."
4035 set allow_avx512bf16_tests 0
4039 remote_file build delete $obj
4041 verbose "$me: returning $allow_avx512bf16_tests" 2
4042 return $allow_avx512bf16_tests
4045 # Run a test on the target to see if it supports avx512fp16. Return 1 if so,
4046 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
4048 gdb_caching_proc allow_avx512fp16_tests {} {
4049 global srcdir subdir gdb_prompt inferior_exited_re
4051 set me "allow_avx512fp16_tests"
4052 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
4053 verbose "$me: target does not support avx512fp16, returning 0" 2
4057 # Compile a test program.
4060 asm volatile ("vcvtps2phx %xmm1, %xmm0");
4064 if {![gdb_simple_compile $me $src executable]} {
4068 # No error message, compilation succeeded so now run it via gdb.
4072 gdb_reinitialize_dir $srcdir/$subdir
4076 -re ".*Illegal instruction.*${gdb_prompt} $" {
4077 verbose -log "$me: avx512fp16 hardware not detected."
4078 set allow_avx512fp16_tests 0
4080 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
4081 verbose -log "$me: avx512fp16 hardware detected."
4082 set allow_avx512fp16_tests 1
4085 warning "\n$me: default case taken."
4086 set allow_avx512fp16_tests 0
4090 remote_file build delete $obj
4092 verbose "$me: returning $allow_avx512fp16_tests" 2
4093 return $allow_avx512fp16_tests
4096 # Run a test on the target to see if it supports btrace hardware. Return 1 if so,
4097 # 0 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
4099 gdb_caching_proc allow_btrace_tests {} {
4100 global srcdir subdir gdb_prompt inferior_exited_re
4102 set me "allow_btrace_tests"
4103 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
4104 verbose "$me: target does not support btrace, returning 0" 2
4108 # Compile a test program.
4109 set src { int main() { return 0; } }
4110 if {![gdb_simple_compile $me $src executable]} {
4114 # No error message, compilation succeeded so now run it via gdb.
4118 gdb_reinitialize_dir $srcdir/$subdir
4123 # In case of an unexpected output, we return 2 as a fail value.
4124 set allow_btrace_tests 2
4125 gdb_test_multiple "record btrace" "check btrace support" {
4126 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
4127 set allow_btrace_tests 0
4129 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
4130 set allow_btrace_tests 0
4132 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
4133 set allow_btrace_tests 0
4135 -re "^record btrace\r\n$gdb_prompt $" {
4136 set allow_btrace_tests 1
4140 remote_file build delete $obj
4142 verbose "$me: returning $allow_btrace_tests" 2
4143 return $allow_btrace_tests
4146 # Run a test on the target to see if it supports btrace pt hardware.
4147 # Return 1 if so, 0 if it does not. Based on 'check_vmx_hw_available'
4148 # from the GCC testsuite.
4150 gdb_caching_proc allow_btrace_pt_tests {} {
4151 global srcdir subdir gdb_prompt inferior_exited_re
4153 set me "allow_btrace_pt_tests"
4154 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
4155 verbose "$me: target does not support btrace, returning 1" 2
4159 # Compile a test program.
4160 set src { int main() { return 0; } }
4161 if {![gdb_simple_compile $me $src executable]} {
4165 # No error message, compilation succeeded so now run it via gdb.
4169 gdb_reinitialize_dir $srcdir/$subdir
4174 # In case of an unexpected output, we return 2 as a fail value.
4175 set allow_btrace_pt_tests 2
4176 gdb_test_multiple "record btrace pt" "check btrace pt support" {
4177 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
4178 set allow_btrace_pt_tests 0
4180 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
4181 set allow_btrace_pt_tests 0
4183 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
4184 set allow_btrace_pt_tests 0
4186 -re "support was disabled at compile time.*\r\n$gdb_prompt $" {
4187 set allow_btrace_pt_tests 0
4189 -re "^record btrace pt\r\n$gdb_prompt $" {
4190 set allow_btrace_pt_tests 1
4194 remote_file build delete $obj
4196 verbose "$me: returning $allow_btrace_pt_tests" 2
4197 return $allow_btrace_pt_tests
4200 # Run a test on the target to see if it supports Aarch64 SVE hardware.
4201 # Return 1 if so, 0 if it does not. Note this causes a restart of GDB.
4203 gdb_caching_proc allow_aarch64_sve_tests {} {
4204 global srcdir subdir gdb_prompt inferior_exited_re
4206 set me "allow_aarch64_sve_tests"
4208 if { ![is_aarch64_target]} {
4212 set compile_flags "{additional_flags=-march=armv8-a+sve}"
4214 # Compile a test program containing SVE instructions.
4217 asm volatile ("ptrue p0.b");
4221 if {![gdb_simple_compile $me $src executable $compile_flags]} {
4225 # Compilation succeeded so now run it via gdb.
4229 -re ".*Illegal instruction.*${gdb_prompt} $" {
4230 verbose -log "\n$me sve hardware not detected"
4231 set allow_sve_tests 0
4233 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
4234 verbose -log "\n$me: sve hardware detected"
4235 set allow_sve_tests 1
4238 warning "\n$me: default case taken"
4239 set allow_sve_tests 0
4243 remote_file build delete $obj
4245 # While testing for SVE support, also discover all the supported vector
4247 aarch64_initialize_sve_information
4249 verbose "$me: returning $allow_sve_tests" 2
4250 return $allow_sve_tests
4253 # Assuming SVE is supported by the target, run some checks to determine all
4254 # the supported vector length values and return an array containing all of those
4255 # values. Since this is a gdb_caching_proc, this proc will only be executed
4258 # To check if a particular SVE vector length is supported, the following code
4259 # can be used. For instance, for vl == 16:
4261 # if {[aarch64_supports_sve_vl 16]} {
4262 # verbose -log "SVE vector length 16 is supported."
4265 # This procedure should NEVER be called by hand, as it reinitializes the GDB
4266 # session and will derail a test. This should be called automatically as part
4267 # of the SVE support test routine allow_aarch64_sve_tests. Users should
4268 # restrict themselves to calling the helper proc aarch64_supports_sve_vl.
4270 gdb_caching_proc aarch64_initialize_sve_information { } {
4273 set src "${srcdir}/lib/aarch64-test-sve.c"
4274 set test_exec [standard_temp_file "aarch64-test-sve.x"]
4275 set compile_flags "{additional_flags=-march=armv8-a+sve}"
4276 array set supported_vl {}
4278 # Compile the SVE vector length test.
4279 set result [gdb_compile $src $test_exec executable [list debug ${compile_flags} nowarnings]]
4281 if {$result != ""} {
4282 verbose -log "Failed to compile SVE information gathering test."
4283 return [array get supported_vl]
4286 clean_restart $test_exec
4288 if {![runto_main]} {
4289 return [array get supported_vl]
4292 set stop_breakpoint "stop here"
4293 gdb_breakpoint [gdb_get_line_number $stop_breakpoint $src]
4294 gdb_continue_to_breakpoint $stop_breakpoint
4296 # Go through the data and extract the supported SVE vector lengths.
4297 set vl_count [get_valueof "" "supported_vl_count" "0" \
4298 "fetch value of supported_vl_count"]
4299 verbose -log "Found $vl_count supported SVE vector length values"
4301 for {set vl_index 0} {$vl_index < $vl_count} {incr vl_index} {
4302 set test_vl [get_valueof "" "supported_vl\[$vl_index\]" "0" \
4303 "fetch value of supported_vl\[$vl_index\]"]
4305 # Mark this vector length as supported.
4306 if {$test_vl != 0} {
4307 verbose -log "Found supported SVE vector length $test_vl"
4308 set supported_vl($test_vl) 1
4313 verbose -log "Cleaning up"
4314 remote_file build delete $test_exec
4316 verbose -log "Done gathering information about AArch64 SVE vector lengths."
4318 # Return the array containing all of the supported SVE vl values.
4319 return [array get supported_vl]
4323 # Return 1 if the target supports SVE vl LENGTH
4324 # Return 0 otherwise.
4327 proc aarch64_supports_sve_vl { length } {
4329 # Fetch the cached array of supported SVE vl values.
4330 array set supported_vl [aarch64_initialize_sve_information]
4332 # Do we have the global values cached?
4333 if {![info exists supported_vl($length)]} {
4334 verbose -log "Target does not support SVE vl $length"
4338 # The target supports SVE vl LENGTH.
4342 # Run a test on the target to see if it supports Aarch64 SME extensions.
4343 # Return 0 if so, 1 if it does not. Note this causes a restart of GDB.
4345 gdb_caching_proc allow_aarch64_sme_tests {} {
4346 global srcdir subdir gdb_prompt inferior_exited_re
4348 set me "allow_aarch64_sme_tests"
4350 if { ![is_aarch64_target]} {
4354 set compile_flags "{additional_flags=-march=armv8-a+sme}"
4356 # Compile a test program containing SME instructions.
4359 asm volatile ("smstart za");
4363 if {![gdb_simple_compile $me $src executable $compile_flags]} {
4364 # Try again, but with a raw hex instruction so we don't rely on
4365 # assembler support for SME.
4367 set compile_flags "{additional_flags=-march=armv8-a}"
4369 # Compile a test program containing SME instructions.
4372 asm volatile (".word 0xD503457F");
4377 if {![gdb_simple_compile $me $src executable $compile_flags]} {
4382 # Compilation succeeded so now run it via gdb.
4386 -re ".*Illegal instruction.*${gdb_prompt} $" {
4387 verbose -log "\n$me sme support not detected"
4388 set allow_sme_tests 0
4390 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
4391 verbose -log "\n$me: sme support detected"
4392 set allow_sme_tests 1
4395 warning "\n$me: default case taken"
4396 set allow_sme_tests 0
4400 remote_file build delete $obj
4402 # While testing for SME support, also discover all the supported vector
4404 aarch64_initialize_sme_information
4406 verbose "$me: returning $allow_sme_tests" 2
4407 return $allow_sme_tests
4410 # Assuming SME is supported by the target, run some checks to determine all
4411 # the supported streaming vector length values and return an array containing
4412 # all of those values. Since this is a gdb_caching_proc, this proc will only
4415 # To check if a particular SME streaming vector length is supported, the
4416 # following code can be used. For instance, for svl == 32:
4418 # if {[aarch64_supports_sme_svl 32]} {
4419 # verbose -log "SME streaming vector length 32 is supported."
4422 # This procedure should NEVER be called by hand, as it reinitializes the GDB
4423 # session and will derail a test. This should be called automatically as part
4424 # of the SME support test routine allow_aarch64_sme_tests. Users should
4425 # restrict themselves to calling the helper proc aarch64_supports_sme_svl.
4427 gdb_caching_proc aarch64_initialize_sme_information { } {
4430 set src "${srcdir}/lib/aarch64-test-sme.c"
4431 set test_exec [standard_temp_file "aarch64-test-sme.x"]
4432 set compile_flags "{additional_flags=-march=armv8-a+sme}"
4433 array set supported_svl {}
4435 # Compile the SME vector length test.
4436 set result [gdb_compile $src $test_exec executable [list debug ${compile_flags} nowarnings]]
4438 if {$result != ""} {
4439 verbose -log "Failed to compile SME information gathering test."
4440 return [array get supported_svl]
4443 clean_restart $test_exec
4445 if {![runto_main]} {
4446 return [array get supported_svl]
4449 set stop_breakpoint "stop here"
4450 gdb_breakpoint [gdb_get_line_number $stop_breakpoint $src]
4451 gdb_continue_to_breakpoint $stop_breakpoint
4453 # Go through the data and extract the supported SME vector lengths.
4454 set svl_count [get_valueof "" "supported_svl_count" "0" \
4455 "fetch value of supported_svl_count"]
4456 verbose -log "Found $svl_count supported SME vector length values"
4458 for {set svl_index 0} {$svl_index < $svl_count} {incr svl_index} {
4459 set test_svl [get_valueof "" "supported_svl\[$svl_index\]" "0" \
4460 "fetch value of supported_svl\[$svl_index\]"]
4462 # Mark this streaming vector length as supported.
4463 if {$test_svl != 0} {
4464 verbose -log "Found supported SME vector length $test_svl"
4465 set supported_svl($test_svl) 1
4470 verbose -log "Cleaning up"
4471 remote_file build delete $test_exec
4473 verbose -log "Done gathering information about AArch64 SME vector lengths."
4475 # Return the array containing all of the supported SME svl values.
4476 return [array get supported_svl]
4480 # Return 1 if the target supports SME svl LENGTH
4481 # Return 0 otherwise.
4484 proc aarch64_supports_sme_svl { length } {
4486 # Fetch the cached array of supported SME svl values.
4487 array set supported_svl [aarch64_initialize_sme_information]
4489 # Do we have the global values cached?
4490 if {![info exists supported_svl($length)]} {
4491 verbose -log "Target does not support SME svl $length"
4495 # The target supports SME svl LENGTH.
4499 # A helper that compiles a test case to see if __int128 is supported.
4500 proc gdb_int128_helper {lang} {
4501 return [gdb_can_simple_compile "i128-for-$lang" {
4503 int main() { return 0; }
4507 # Return true if the C compiler understands the __int128 type.
4508 gdb_caching_proc has_int128_c {} {
4509 return [gdb_int128_helper c]
4512 # Return true if the C++ compiler understands the __int128 type.
4513 gdb_caching_proc has_int128_cxx {} {
4514 return [gdb_int128_helper c++]
4517 # Return true if the IFUNC feature is supported.
4518 gdb_caching_proc allow_ifunc_tests {} {
4519 if [gdb_can_simple_compile ifunc {
4521 typedef void F (void);
4522 F* g (void) { return &f_; }
4523 void f () __attribute__ ((ifunc ("g")));
4531 # Return whether we should skip tests for showing inlined functions in
4532 # backtraces. Requires get_compiler_info and get_debug_format.
4534 proc skip_inline_frame_tests {} {
4535 # GDB only recognizes inlining information in DWARF.
4536 if { ! [test_debug_format "DWARF \[0-9\]"] } {
4540 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
4541 if { ([test_compiler_info "gcc-2-*"]
4542 || [test_compiler_info "gcc-3-*"]
4543 || [test_compiler_info "gcc-4-0-*"]) } {
4550 # Return whether we should skip tests for showing variables from
4551 # inlined functions. Requires get_compiler_info and get_debug_format.
4553 proc skip_inline_var_tests {} {
4554 # GDB only recognizes inlining information in DWARF.
4555 if { ! [test_debug_format "DWARF \[0-9\]"] } {
4562 # Return a 1 if we should run tests that require hardware breakpoints
4564 proc allow_hw_breakpoint_tests {} {
4565 # Skip tests if requested by the board (note that no_hardware_watchpoints
4566 # disables both watchpoints and breakpoints)
4567 if { [target_info exists gdb,no_hardware_watchpoints]} {
4571 # These targets support hardware breakpoints natively
4572 if { [istarget "i?86-*-*"]
4573 || [istarget "x86_64-*-*"]
4574 || [istarget "ia64-*-*"]
4575 || [istarget "arm*-*-*"]
4576 || [istarget "aarch64*-*-*"]
4577 || [istarget "s390*-*-*"] } {
4584 # Return a 1 if we should run tests that require hardware watchpoints
4586 proc allow_hw_watchpoint_tests {} {
4587 # Skip tests if requested by the board
4588 if { [target_info exists gdb,no_hardware_watchpoints]} {
4592 # These targets support hardware watchpoints natively
4593 # Note, not all Power 9 processors support hardware watchpoints due to a HW
4594 # bug. Use has_hw_wp_support to check do a runtime check for hardware
4595 # watchpoint support on Powerpc.
4596 if { [istarget "i?86-*-*"]
4597 || [istarget "x86_64-*-*"]
4598 || [istarget "ia64-*-*"]
4599 || [istarget "arm*-*-*"]
4600 || [istarget "aarch64*-*-*"]
4601 || ([istarget "powerpc*-*-linux*"] && [has_hw_wp_support])
4602 || [istarget "s390*-*-*"] } {
4609 # Return a 1 if we should run tests that require *multiple* hardware
4610 # watchpoints to be active at the same time
4612 proc allow_hw_watchpoint_multi_tests {} {
4613 if { ![allow_hw_watchpoint_tests] } {
4617 # These targets support just a single hardware watchpoint
4618 if { [istarget "arm*-*-*"]
4619 || [istarget "powerpc*-*-linux*"] } {
4626 # Return a 1 if we should run tests that require read/access watchpoints
4628 proc allow_hw_watchpoint_access_tests {} {
4629 if { ![allow_hw_watchpoint_tests] } {
4633 # These targets support just write watchpoints
4634 if { [istarget "s390*-*-*"] } {
4641 # Return 1 if we should skip tests that require the runtime unwinder
4642 # hook. This must be invoked while gdb is running, after shared
4643 # libraries have been loaded. This is needed because otherwise a
4644 # shared libgcc won't be visible.
4646 proc skip_unwinder_tests {} {
4650 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
4651 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
4653 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
4656 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
4660 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
4661 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
4664 -re "\r\n$gdb_prompt $" {
4671 # Return 1 if we should skip tests that require the libstdc++ stap
4672 # probes. This must be invoked while gdb is running, after shared
4673 # libraries have been loaded. PROMPT_REGEXP is the expected prompt.
4675 proc skip_libstdcxx_probe_tests_prompt { prompt_regexp } {
4677 gdb_test_multiple "info probe" "check for stap probe in libstdc++" \
4678 -prompt "$prompt_regexp" {
4679 -re ".*libstdcxx.*catch.*\r\n$prompt_regexp" {
4682 -re "\r\n$prompt_regexp" {
4685 set skip [expr !$supported]
4689 # As skip_libstdcxx_probe_tests_prompt, with gdb_prompt.
4691 proc skip_libstdcxx_probe_tests {} {
4693 return [skip_libstdcxx_probe_tests_prompt "$gdb_prompt $"]
4696 # Return 1 if libc supports the longjmp probe. Note that we're not using
4697 # gdb_caching_proc because the probe may have been disabled.
4699 proc have_longjmp_probe {} {
4701 gdb_test_multiple "info probes stap libc ^longjmp$" "" {
4702 -re -wrap "No probes matched\\." {
4705 -re -wrap "\r\nstap\[ \t\]+libc\[ \t\]+longjmp\[ \t\]+.*" {
4709 if { $have_probe == -1 } {
4710 error "failed to get libc longjmp probe status"
4715 # Returns true if gdb_protocol is empty, indicating use of the native
4718 proc gdb_protocol_is_native { } {
4719 return [expr {[target_info gdb_protocol] == ""}]
4722 # Returns true if gdb_protocol is either "remote" or
4723 # "extended-remote".
4725 proc gdb_protocol_is_remote { } {
4726 return [expr {[target_info gdb_protocol] == "remote"
4727 || [target_info gdb_protocol] == "extended-remote"}]
4730 # Like istarget, but checks a list of targets.
4731 proc is_any_target {args} {
4732 foreach targ $args {
4733 if {[istarget $targ]} {
4740 # Return the effective value of use_gdb_stub.
4742 # If the use_gdb_stub global has been set (it is set when the gdb process is
4743 # spawned), return that. Otherwise, return the value of the use_gdb_stub
4744 # property from the board file.
4746 # This is the preferred way of checking use_gdb_stub, since it allows to check
4747 # the value before the gdb has been spawned and it will return the correct value
4748 # even when it was overriden by the test.
4750 # Note that stub targets are not able to spawn new inferiors. Use this
4751 # check for skipping respective tests.
4753 proc use_gdb_stub {} {
4756 if [info exists use_gdb_stub] {
4757 return $use_gdb_stub
4760 return [target_info exists use_gdb_stub]
4763 # Return 1 if the current remote target is an instance of our GDBserver, 0
4764 # otherwise. Return -1 if there was an error and we can't tell.
4766 gdb_caching_proc target_is_gdbserver {} {
4770 set test "probing for GDBserver"
4772 gdb_test_multiple "monitor help" $test {
4773 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
4776 -re "$gdb_prompt $" {
4781 if { $is_gdbserver == -1 } {
4782 verbose -log "Unable to tell whether we are using GDBserver or not."
4785 return $is_gdbserver
4788 # N.B. compiler_info is intended to be local to this file.
4789 # Call test_compiler_info with no arguments to fetch its value.
4790 # Yes, this is counterintuitive when there's get_compiler_info,
4791 # but that's the current API.
4792 if [info exists compiler_info] {
4796 # Figure out what compiler I am using.
4797 # The result is cached so only the first invocation runs the compiler.
4799 # ARG can be empty or "C++". If empty, "C" is assumed.
4801 # There are several ways to do this, with various problems.
4803 # [ gdb_compile -E $ifile -o $binfile.ci ]
4804 # source $binfile.ci
4806 # Single Unix Spec v3 says that "-E -o ..." together are not
4807 # specified. And in fact, the native compiler on hp-ux 11 (among
4808 # others) does not work with "-E -o ...". Most targets used to do
4809 # this, and it mostly worked, because it works with gcc.
4811 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
4812 # source $binfile.ci
4814 # This avoids the problem with -E and -o together. This almost works
4815 # if the build machine is the same as the host machine, which is
4816 # usually true of the targets which are not gcc. But this code does
4817 # not figure which compiler to call, and it always ends up using the C
4818 # compiler. Not good for setting hp_aCC_compiler. Target
4819 # hppa*-*-hpux* used to do this.
4821 # [ gdb_compile -E $ifile > $binfile.ci ]
4822 # source $binfile.ci
4824 # dejagnu target_compile says that it supports output redirection,
4825 # but the code is completely different from the normal path and I
4826 # don't want to sweep the mines from that path. So I didn't even try
4829 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
4832 # I actually do this for all targets now. gdb_compile runs the right
4833 # compiler, and TCL captures the output, and I eval the output.
4835 # Unfortunately, expect logs the output of the command as it goes by,
4836 # and dejagnu helpfully prints a second copy of it right afterwards.
4837 # So I turn off expect logging for a moment.
4839 # [ gdb_compile $ifile $ciexe_file executable $args ]
4840 # [ remote_exec $ciexe_file ]
4841 # [ source $ci_file.out ]
4843 # I could give up on -E and just do this.
4844 # I didn't get desperate enough to try this.
4846 # -- chastain 2004-01-06
4848 proc get_compiler_info {{language "c"}} {
4850 # For compiler.c, compiler.cc and compiler.F90.
4853 # I am going to play with the log to keep noise out.
4857 # These come from compiler.c, compiler.cc or compiler.F90.
4858 gdb_persistent_global compiler_info_cache
4860 if [info exists compiler_info_cache($language)] {
4865 # Choose which file to preprocess.
4866 if { $language == "c++" } {
4867 set ifile "${srcdir}/lib/compiler.cc"
4868 } elseif { $language == "f90" } {
4869 set ifile "${srcdir}/lib/compiler.F90"
4870 } elseif { $language == "c" } {
4871 set ifile "${srcdir}/lib/compiler.c"
4873 perror "Unable to fetch compiler version for language: $language"
4877 # Run $ifile through the right preprocessor.
4878 # Toggle gdb.log to keep the compiler output out of the log.
4879 set saved_log [log_file -info]
4881 if [is_remote host] {
4882 # We have to use -E and -o together, despite the comments
4883 # above, because of how DejaGnu handles remote host testing.
4884 set ppout [standard_temp_file compiler.i]
4885 gdb_compile "${ifile}" "$ppout" preprocess [list "$language" quiet getting_compiler_info]
4886 set file [open $ppout r]
4887 set cppout [read $file]
4890 # Copy $ifile to temp dir, to work around PR gcc/60447. This will leave the
4891 # superfluous .s file in the temp dir instead of in the source dir.
4892 set tofile [file tail $ifile]
4893 set tofile [standard_temp_file $tofile]
4894 file copy -force $ifile $tofile
4896 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$language" quiet getting_compiler_info] ]
4898 eval log_file $saved_log
4902 foreach cppline [ split "$cppout" "\n" ] {
4903 if { [ regexp "^#" "$cppline" ] } {
4905 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
4907 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
4909 verbose "get_compiler_info: $cppline" 2
4911 } elseif { [ regexp {[fc]lang.*warning.*'-fdiagnostics-color=never'} "$cppline"] } {
4912 # Both flang preprocessors (llvm flang and classic flang) print a
4913 # warning for the unused -fdiagnostics-color=never, so we skip this
4915 # The armflang preprocessor has been observed to output the
4916 # warning prefixed with "clang", so the regex also accepts
4920 verbose -log "get_compiler_info: $cppline"
4925 # Set to unknown if for some reason compiler_info didn't get defined.
4926 if ![info exists compiler_info] {
4927 verbose -log "get_compiler_info: compiler_info not provided"
4928 set compiler_info "unknown"
4930 # Also set to unknown compiler if any diagnostics happened.
4932 verbose -log "get_compiler_info: got unexpected diagnostics"
4933 set compiler_info "unknown"
4936 set compiler_info_cache($language) $compiler_info
4938 # Log what happened.
4939 verbose -log "get_compiler_info: $compiler_info"
4944 # Return the compiler_info string if no arg is provided.
4945 # Otherwise the argument is a glob-style expression to match against
4948 proc test_compiler_info { {compiler ""} {language "c"} } {
4949 gdb_persistent_global compiler_info_cache
4951 if [get_compiler_info $language] {
4952 # An error will already have been printed in this case. Just
4953 # return a suitable result depending on how the user called
4955 if [string match "" $compiler] {
4962 # If no arg, return the compiler_info string.
4963 if [string match "" $compiler] {
4964 return $compiler_info_cache($language)
4967 return [string match $compiler $compiler_info_cache($language)]
4970 # Return true if the C compiler is GCC, otherwise, return false.
4972 proc is_c_compiler_gcc {} {
4973 set compiler_info [test_compiler_info]
4974 set gcc_compiled false
4975 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
4976 return $gcc_compiled
4979 # Return the gcc major version, or -1.
4980 # For gcc 4.8.5, the major version is 4.8.
4981 # For gcc 7.5.0, the major version 7.
4982 # The COMPILER and LANGUAGE arguments are as for test_compiler_info.
4984 proc gcc_major_version { {compiler "gcc-*"} {language "c"} } {
4986 if { ![test_compiler_info $compiler $language] } {
4989 # Strip "gcc-*" to "gcc".
4990 regsub -- {-.*} $compiler "" compiler
4991 set res [regexp $compiler-($decimal)-($decimal)- \
4992 [test_compiler_info "" $language] \
4993 dummy_var major minor]
5000 return $major.$minor
5003 proc current_target_name { } {
5005 if [info exists target_info(target,name)] {
5006 set answer $target_info(target,name)
5013 set gdb_wrapper_initialized 0
5014 set gdb_wrapper_target ""
5015 set gdb_wrapper_file ""
5016 set gdb_wrapper_flags ""
5018 proc gdb_wrapper_init { args } {
5019 global gdb_wrapper_initialized
5020 global gdb_wrapper_file
5021 global gdb_wrapper_flags
5022 global gdb_wrapper_target
5024 if { $gdb_wrapper_initialized == 1 } { return; }
5026 if {[target_info exists needs_status_wrapper] && \
5027 [target_info needs_status_wrapper] != "0"} {
5028 set result [build_wrapper "testglue.o"]
5029 if { $result != "" } {
5030 set gdb_wrapper_file [lindex $result 0]
5031 if ![is_remote host] {
5032 set gdb_wrapper_file [file join [pwd] $gdb_wrapper_file]
5034 set gdb_wrapper_flags [lindex $result 1]
5036 warning "Status wrapper failed to build."
5039 set gdb_wrapper_file ""
5040 set gdb_wrapper_flags ""
5042 verbose "set gdb_wrapper_file = $gdb_wrapper_file"
5043 set gdb_wrapper_initialized 1
5044 set gdb_wrapper_target [current_target_name]
5047 # Determine options that we always want to pass to the compiler.
5048 proc universal_compile_options {src obj} {
5051 # Try an option for disabling colored diagnostics. Some compilers
5052 # yield colored diagnostics by default (when run from a tty) unless
5053 # such an option is specified.
5054 set opt "additional_flags=-fdiagnostics-color=never"
5055 set lines [target_compile $src $obj object [list "quiet" $opt]]
5056 if {[string match "" $lines]} {
5057 # Seems to have worked; use the option.
5058 lappend options $opt
5064 # Determine options that we always want to pass to the C compiler.
5065 gdb_caching_proc universal_compile_options_c {} {
5066 set me "universal_compile_options_c"
5068 set src [standard_temp_file ccopts.c]
5069 set obj [standard_temp_file ccopts.o]
5071 gdb_produce_source $src {
5072 int foo(void) { return 0; }
5075 set options [universal_compile_options $src $obj]
5080 verbose "$me: returning $options" 2
5084 # Determine options that we always want to pass to the compiler for
5085 # assembly source files with the extension ".s".
5086 gdb_caching_proc universal_compile_options_assembly {} {
5087 set me "universal_compile_options_assembly"
5089 set src [standard_temp_file ccopts.s]
5090 set obj [standard_temp_file csymbol.o]
5092 gdb_produce_source $src {
5096 set options [universal_compile_options $src $obj]
5099 verbose "$me: returning $options" 2
5103 # Compile the code in $code to a file based on $name, using the flags
5104 # $compile_flag as well as debug, nowarning and quiet (unless otherwise
5105 # specified in default_compile_flags).
5106 # Return 1 if code can be compiled
5107 # Leave the file name of the resulting object in the upvar object.
5109 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj} {default_compile_flags {}}} {
5112 switch -regexp -- $type {
5127 foreach flag $compile_flags {
5128 if { "$flag" == "go" } {
5132 if { "$flag" eq "hip" } {
5136 if { "$flag" eq "d" } {
5141 set src [standard_temp_file $name.$ext]
5142 set obj [standard_temp_file $name.$postfix]
5143 if { $default_compile_flags == "" } {
5144 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
5146 set compile_flags [concat $compile_flags $default_compile_flags]
5149 gdb_produce_source $src $code
5151 verbose "$name: compiling testfile $src" 2
5152 set lines [gdb_compile $src $obj $type $compile_flags]
5156 if {![string match "" $lines]} {
5157 verbose "$name: compilation failed, returning 0" 2
5163 # Compile the code in $code to a file based on $name, using the flags
5164 # $compile_flag as well as debug, nowarning and quiet (unless otherwise
5165 # specified in default_compile_flags).
5166 # Return 1 if code can be compiled
5167 # Delete all created files and objects.
5169 proc gdb_can_simple_compile {name code {type object} {compile_flags ""} {default_compile_flags ""}} {
5170 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj \
5171 $default_compile_flags]
5172 file delete $temp_obj
5176 # As gdb_can_simple_compile, but defaults to using nodebug instead of debug.
5177 proc gdb_can_simple_compile_nodebug {name code {type object} {compile_flags ""}
5178 {default_compile_flags "nodebug nowarning quiet"}} {
5179 return [gdb_can_simple_compile $name $code $type $compile_flags \
5180 $default_compile_flags]
5183 # Some targets need to always link a special object in. Save its path here.
5184 global gdb_saved_set_unbuffered_mode_obj
5185 set gdb_saved_set_unbuffered_mode_obj ""
5187 # Escape STR sufficiently for use on host commandline.
5189 proc escape_for_host { str } {
5190 if { [is_remote host] } {
5200 return [string map $map $str]
5203 # Add double quotes around ARGS, sufficiently escaped for use on host
5206 proc quote_for_host { args } {
5207 set str [join $args]
5208 if { [is_remote host] } {
5209 set str [join [list {\"} $str {\"}] ""]
5211 set str [join [list {"} $str {"}] ""]
5216 # Compile source files specified by SOURCE into a binary of type TYPE at path
5217 # DEST. gdb_compile is implemented using DejaGnu's target_compile, so the type
5218 # parameter and most options are passed directly to it.
5220 # The type can be one of the following:
5222 # - object: Compile into an object file.
5223 # - executable: Compile and link into an executable.
5224 # - preprocess: Preprocess the source files.
5225 # - assembly: Generate assembly listing.
5227 # The following options are understood and processed by gdb_compile:
5229 # - shlib=so_path: Add SO_PATH to the sources, and enable some target-specific
5230 # quirks to be able to use shared libraries.
5231 # - shlib_load: Link with appropriate libraries to allow the test to
5232 # dynamically load libraries at runtime. For example, on Linux, this adds
5233 # -ldl so that the test can use dlopen.
5234 # - nowarnings: Inhibit all compiler warnings.
5235 # - pie: Force creation of PIE executables.
5236 # - nopie: Prevent creation of PIE executables.
5237 # - macros: Add the required compiler flag to include macro information in
5239 # - text_segment=addr: Tell the linker to place the text segment at ADDR.
5240 # - build-id: Ensure the final binary includes a build-id.
5241 # - column-info/no-column-info: Enable/Disable generation of column table
5244 # And here are some of the not too obscure options understood by DejaGnu that
5245 # influence the compilation:
5247 # - additional_flags=flag: Add FLAG to the compiler flags.
5248 # - libs=library: Add LIBRARY to the libraries passed to the linker. The
5249 # argument can be a file, in which case it's added to the sources, or a
5251 # - ldflags=flag: Add FLAG to the linker flags.
5252 # - incdir=path: Add PATH to the searched include directories.
5253 # - libdir=path: Add PATH to the linker searched directories.
5254 # - ada, c++, f90, go, rust: Compile the file as Ada, C++,
5255 # Fortran 90, Go or Rust.
5256 # - debug: Build with debug information.
5257 # - optimize: Build with optimization.
5259 proc gdb_compile {source dest type options} {
5260 global GDB_TESTCASE_OPTIONS
5261 global gdb_wrapper_file
5262 global gdb_wrapper_flags
5265 global gdb_saved_set_unbuffered_mode_obj
5267 set outdir [file dirname $dest]
5269 # If this is set, calling test_compiler_info will cause recursion.
5270 if { [lsearch -exact $options getting_compiler_info] == -1 } {
5271 set getting_compiler_info false
5273 set getting_compiler_info true
5276 # Add platform-specific options if a shared library was specified using
5277 # "shlib=librarypath" in OPTIONS.
5279 if {[lsearch -exact $options rust] != -1} {
5280 # -fdiagnostics-color is not a rustcc option.
5282 # icx/clang compilers support the -fdiagnostics-color option for
5283 # ".S" files and only it is not supported for ".s" files.
5284 if {[string match *.s $source] != 0} {
5285 set new_options [universal_compile_options_assembly]
5287 set new_options [universal_compile_options_c]
5291 # C/C++ specific settings.
5292 if {!$getting_compiler_info
5293 && [lsearch -exact $options rust] == -1
5294 && [lsearch -exact $options ada] == -1
5295 && [lsearch -exact $options f90] == -1
5296 && [lsearch -exact $options go] == -1} {
5298 # Some C/C++ testcases unconditionally pass -Wno-foo as additional
5299 # options to disable some warning. That is OK with GCC, because
5300 # by design, GCC accepts any -Wno-foo option, even if it doesn't
5301 # support -Wfoo. Clang however warns about unknown -Wno-foo by
5302 # default, unless you pass -Wno-unknown-warning-option as well.
5303 # We do that here, so that individual testcases don't have to
5305 if {[test_compiler_info "clang-*"] || [test_compiler_info "icx-*"]} {
5306 lappend new_options "additional_flags=-Wno-unknown-warning-option"
5307 } elseif {[test_compiler_info "icc-*"]} {
5308 # This is the equivalent for the icc compiler.
5309 lappend new_options "additional_flags=-diag-disable=10148"
5312 # icpx/icx give the following warning if '-g' is used without '-O'.
5314 # icpx: remark: Note that use of '-g' without any
5315 # optimization-level option will turn off most compiler
5316 # optimizations similar to use of '-O0'
5318 # The warning makes dejagnu think that compilation has failed.
5320 # Furthermore, if no -O flag is passed, icx and icc optimize
5321 # the code by default. This breaks assumptions in many GDB
5322 # tests that the code is unoptimized by default.
5324 # To fix both problems, pass the -O0 flag explicitly, if no
5325 # optimization option is given.
5326 if {[test_compiler_info "icx-*"] || [test_compiler_info "icc-*"]} {
5327 if {[lsearch $options optimize=*] == -1
5328 && [lsearch $options additional_flags=-O*] == -1} {
5329 lappend new_options "optimize=-O0"
5333 # Starting with 2021.7.0 (recognized as icc-20-21-7 by GDB) icc and
5334 # icpc are marked as deprecated and both compilers emit the remark
5335 # #10441. To let GDB still compile successfully, we disable these
5337 if {([lsearch -exact $options c++] != -1
5338 && [test_compiler_info {icc-20-21-[7-9]} c++])
5339 || [test_compiler_info {icc-20-21-[7-9]}]} {
5340 lappend new_options "additional_flags=-diag-disable=10441"
5344 # If the 'build-id' option is used, then ensure that we generate a
5345 # build-id. GCC does this by default, but Clang does not, so
5347 if {[lsearch -exact $options build-id] > 0
5348 && [test_compiler_info "clang-*"]} {
5349 lappend new_options "additional_flags=-Wl,--build-id"
5352 # Treating .c input files as C++ is deprecated in Clang, so
5353 # explicitly force C++ language.
5354 if { !$getting_compiler_info
5355 && [lsearch -exact $options c++] != -1
5356 && [string match *.c $source] != 0 } {
5358 # gdb_compile cannot handle this combination of options, the
5359 # result is a command like "clang -x c++ foo.c bar.so -o baz"
5360 # which tells Clang to treat bar.so as C++. The solution is
5361 # to call gdb_compile twice--once to compile, once to link--
5362 # either directly, or via build_executable_from_specs.
5363 if { [lsearch $options shlib=*] != -1 } {
5364 error "incompatible gdb_compile options"
5367 if {[test_compiler_info "clang-*"]} {
5368 lappend new_options early_flags=-x\ c++
5372 # Place (and look for) Fortran `.mod` files in the output
5373 # directory for this specific test. For Intel compilers the -J
5374 # option is not supported so instead use the -module flag.
5375 # Additionally, Intel compilers need the -debug-parameters flag set to
5376 # emit debug info for all parameters in modules.
5378 # ifx gives the following warning if '-g' is used without '-O'.
5380 # ifx: remark #10440: Note that use of a debug option
5381 # without any optimization-level option will turnoff most
5382 # compiler optimizations similar to use of '-O0'
5384 # The warning makes dejagnu think that compilation has failed.
5386 # Furthermore, if no -O flag is passed, Intel compilers optimize
5387 # the code by default. This breaks assumptions in many GDB
5388 # tests that the code is unoptimized by default.
5390 # To fix both problems, pass the -O0 flag explicitly, if no
5391 # optimization option is given.
5392 if { !$getting_compiler_info && [lsearch -exact $options f90] != -1 } {
5394 set mod_path [standard_output_file ""]
5395 if { [test_compiler_info {gfortran-*} f90] } {
5396 lappend new_options "additional_flags=-J${mod_path}"
5397 } elseif { [test_compiler_info {ifort-*} f90]
5398 || [test_compiler_info {ifx-*} f90] } {
5399 lappend new_options "additional_flags=-module ${mod_path}"
5400 lappend new_options "additional_flags=-debug-parameters all"
5402 if {[lsearch $options optimize=*] == -1
5403 && [lsearch $options additional_flags=-O*] == -1} {
5404 lappend new_options "optimize=-O0"
5411 foreach opt $options {
5412 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
5413 && $type == "executable"} {
5414 if [test_compiler_info "xlc-*"] {
5415 # IBM xlc compiler doesn't accept shared library named other
5416 # than .so: use "-Wl," to bypass this
5417 lappend source "-Wl,$shlib_name"
5418 } elseif { ([istarget "*-*-mingw*"]
5419 || [istarget *-*-cygwin*]
5420 || [istarget *-*-pe*])} {
5421 lappend source "${shlib_name}.a"
5423 lappend source $shlib_name
5425 if { $shlib_found == 0 } {
5427 if { ([istarget "*-*-mingw*"]
5428 || [istarget *-*-cygwin*]) } {
5429 lappend new_options "ldflags=-Wl,--enable-auto-import"
5431 if { [test_compiler_info "gcc-*"] || [test_compiler_info "clang-*"] } {
5432 # Undo debian's change in the default.
5433 # Put it at the front to not override any user-provided
5434 # value, and to make sure it appears in front of all the
5436 lappend new_options "early_flags=-Wl,--no-as-needed"
5439 } elseif { $opt == "shlib_load" && $type == "executable" } {
5441 } elseif { $opt == "getting_compiler_info" } {
5442 # Ignore this setting here as it has been handled earlier in this
5443 # procedure. Do not append it to new_options as this will cause
5445 } elseif {[regexp "^text_segment=(.*)" $opt dummy_var addr]} {
5446 if { [linker_supports_Ttext_segment_flag] } {
5448 lappend new_options "ldflags=-Wl,-Ttext-segment=$addr"
5449 } elseif { [linker_supports_image_base_flag] } {
5451 lappend new_options "ldflags=-Wl,--image-base=$addr"
5452 } elseif { [linker_supports_Ttext_flag] } {
5453 # For old GNU gold versions.
5454 lappend new_options "ldflags=-Wl,-Ttext=$addr"
5456 error "Don't know how to handle text_segment option."
5458 } elseif { $opt == "column-info" } {
5459 # If GCC or clang does not support column-info, compilation
5460 # will fail and the usupported column-info option will be
5462 if {[test_compiler_info {gcc-*}]} {
5463 lappend new_options "additional_flags=-gcolumn-info"
5465 } elseif {[test_compiler_info {clang-*}]} {
5466 lappend new_options "additional_flags=-gcolumn-info"
5469 error "Option gcolumn-info not supported by compiler."
5472 } elseif { $opt == "no-column-info" } {
5473 if {[test_compiler_info {gcc-*}]} {
5474 if {[test_compiler_info {gcc-[1-6]-*}]} {
5475 # In this case, don't add the compile line option and
5476 # the result will be the same as using no-column-info
5477 # on a version that supports the option.
5478 warning "gdb_compile option no-column-info not supported, ignoring."
5480 lappend new_options "additional_flags=-gno-column-info"
5483 } elseif {[test_compiler_info {clang-*}]} {
5484 lappend new_options "additional_flags=-gno-column-info"
5487 error "Option gno-column-info not supported by compiler."
5491 lappend new_options $opt
5495 # Ensure stack protector is disabled for GCC, as this causes problems with
5496 # DWARF line numbering.
5497 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
5498 # This option defaults to on for Debian/Ubuntu.
5499 if { !$getting_compiler_info
5500 && [test_compiler_info {gcc-*-*}]
5501 && !([test_compiler_info {gcc-[0-3]-*}]
5502 || [test_compiler_info {gcc-4-0-*}])
5503 && [lsearch -exact $options rust] == -1} {
5504 # Put it at the front to not override any user-provided value.
5505 lappend new_options "early_flags=-fno-stack-protector"
5508 # hipcc defaults to -O2, so add -O0 to early flags for the hip language.
5509 # If "optimize" is also requested, another -O flag (e.g. -O2) will be added
5510 # to the flags, overriding this -O0.
5511 if {[lsearch -exact $options hip] != -1} {
5512 lappend new_options "early_flags=-O0"
5515 # Because we link with libraries using their basename, we may need
5516 # (depending on the platform) to set a special rpath value, to allow
5517 # the executable to find the libraries it depends on.
5518 if { $shlib_load || $shlib_found } {
5519 if { ([istarget "*-*-mingw*"]
5520 || [istarget *-*-cygwin*]
5521 || [istarget *-*-pe*]) } {
5522 # Do not need anything.
5523 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
5524 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
5526 if { $shlib_load } {
5527 lappend new_options "libs=-ldl"
5529 lappend new_options [escape_for_host {ldflags=-Wl,-rpath,$ORIGIN}]
5532 set options $new_options
5534 if [info exists GDB_TESTCASE_OPTIONS] {
5535 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
5537 verbose "options are $options"
5538 verbose "source is $source $dest $type $options"
5542 if {[target_info exists needs_status_wrapper] && \
5543 [target_info needs_status_wrapper] != "0" && \
5544 $gdb_wrapper_file != "" } {
5545 lappend options "libs=${gdb_wrapper_file}"
5546 lappend options "ldflags=${gdb_wrapper_flags}"
5549 # Replace the "nowarnings" option with the appropriate additional_flags
5550 # to disable compiler warnings.
5551 set nowarnings [lsearch -exact $options nowarnings]
5552 if {$nowarnings != -1} {
5553 if [target_info exists gdb,nowarnings_flag] {
5554 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
5556 set flag "additional_flags=-w"
5558 set options [lreplace $options $nowarnings $nowarnings $flag]
5561 # Replace the "pie" option with the appropriate compiler and linker flags
5562 # to enable PIE executables.
5563 set pie [lsearch -exact $options pie]
5565 if [target_info exists gdb,pie_flag] {
5566 set flag "additional_flags=[target_info gdb,pie_flag]"
5568 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
5569 # and SPARC, fpie can cause compile errors due to the GOT exceeding
5570 # a maximum size. On other architectures the two flags are
5571 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
5572 # onwards default GCC to using fPIE. If you do require fpie, then
5573 # it can be set using the pie_flag.
5574 set flag "additional_flags=-fPIE"
5576 set options [lreplace $options $pie $pie $flag]
5578 if [target_info exists gdb,pie_ldflag] {
5579 set flag "ldflags=[target_info gdb,pie_ldflag]"
5581 set flag "ldflags=-pie"
5583 lappend options "$flag"
5586 # Replace the "nopie" option with the appropriate compiler and linker
5587 # flags to disable PIE executables.
5588 set nopie [lsearch -exact $options nopie]
5590 if [target_info exists gdb,nopie_flag] {
5591 set flag "additional_flags=[target_info gdb,nopie_flag]"
5593 set flag "additional_flags=-fno-pie"
5595 set options [lreplace $options $nopie $nopie $flag]
5597 if [target_info exists gdb,nopie_ldflag] {
5598 set flag "ldflags=[target_info gdb,nopie_ldflag]"
5600 set flag "ldflags=-no-pie"
5602 lappend options "$flag"
5605 set macros [lsearch -exact $options macros]
5606 if {$macros != -1} {
5607 if { [test_compiler_info "clang-*"] } {
5608 set flag "additional_flags=-fdebug-macro"
5610 set flag "additional_flags=-g3"
5613 set options [lreplace $options $macros $macros $flag]
5616 if { $type == "executable" } {
5617 if { ([istarget "*-*-mingw*"]
5618 || [istarget "*-*-*djgpp"]
5619 || [istarget "*-*-cygwin*"])} {
5620 # Force output to unbuffered mode, by linking in an object file
5621 # with a global contructor that calls setvbuf.
5623 # Compile the special object separately for two reasons:
5624 # 1) Insulate it from $options.
5625 # 2) Avoid compiling it for every gdb_compile invocation,
5626 # which is time consuming, especially if we're remote
5629 # Note the special care for GDB_PARALLEL. In that
5630 # scenario, multiple expect instances will potentially try
5631 # to compile the object file at the same time. The result
5632 # should be identical for every one of them, so we just
5633 # need to make sure that the final objfile is written to
5636 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
5637 verbose "compiling gdb_saved_set_unbuffered_obj"
5638 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
5639 # This gives us a per-expect-instance unique filename,
5640 # which is important for GDB_PARALLEL. See comments
5642 set unbuf_obj [standard_temp_file set_unbuffered_mode.o]
5644 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
5645 if { $result != "" } {
5648 if {[is_remote host]} {
5649 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
5651 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
5653 # Link a copy of the output object, because the
5654 # original may be automatically deleted.
5655 if {[info exists ::GDB_PARALLEL]} {
5656 # Make sure to write the .o file atomically.
5657 # (Note GDB_PARALLEL mode does not support remote
5659 file rename -force -- $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
5661 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
5664 verbose "gdb_saved_set_unbuffered_obj already compiled"
5667 # Rely on the internal knowledge that the global ctors are ran in
5668 # reverse link order. In that case, we can use ldflags to
5669 # avoid copying the object file to the host multiple
5671 # This object can only be added if standard libraries are
5672 # used. Thus, we need to disable it if -nostdlib option is used
5673 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
5674 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
5679 cond_wrap [expr $pie != -1 || $nopie != -1] \
5680 with_PIE_multilib_flags_filtered {
5681 set result [target_compile $source $dest $type $options]
5684 # Prune uninteresting compiler (and linker) output.
5685 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
5687 # Starting with 2021.7.0 icc and icpc are marked as deprecated and both
5688 # compilers emit a remark #10441. To let GDB still compile successfully,
5689 # we disable these warnings. When $getting_compiler_info is true however,
5690 # we do not yet know the compiler (nor its version) and instead prune these
5691 # lines from the compiler output to let the get_compiler_info pass.
5692 if {$getting_compiler_info} {
5694 "(icc|icpc): remark #10441: The Intel\\(R\\) C\\+\\+ Compiler Classic \\(ICC\\) is deprecated\[^\r\n\]*" \
5698 regsub "\[\r\n\]*$" "$result" "" result
5699 regsub "^\[\r\n\]*" "$result" "" result
5701 if { $type == "executable" && $result == "" \
5702 && ($nopie != -1 || $pie != -1) } {
5703 set is_pie [exec_is_pie "$dest"]
5704 if { $nopie != -1 && $is_pie == 1 } {
5705 set result "nopie failed to prevent PIE executable"
5706 } elseif { $pie != -1 && $is_pie == 0 } {
5707 set result "pie failed to generate PIE executable"
5711 if {[lsearch $options quiet] < 0} {
5712 if { $result != "" } {
5713 clone_output "gdb compile failed, $result"
5720 # This is just like gdb_compile, above, except that it tries compiling
5721 # against several different thread libraries, to see which one this
5723 proc gdb_compile_pthreads {source dest type options} {
5724 if {$type != "executable"} {
5725 return [gdb_compile $source $dest $type $options]
5728 set why_msg "unrecognized error"
5729 foreach lib {-lpthreads -lpthread -lthread ""} {
5730 # This kind of wipes out whatever libs the caller may have
5731 # set. Or maybe theirs will override ours. How infelicitous.
5732 set options_with_lib [concat $options [list libs=$lib quiet]]
5733 set ccout [gdb_compile $source $dest $type $options_with_lib]
5734 switch -regexp -- $ccout {
5735 ".*no posix threads support.*" {
5736 set why_msg "missing threads include file"
5739 ".*cannot open -lpthread.*" {
5740 set why_msg "missing runtime threads library"
5742 ".*Can't find library for -lpthread.*" {
5743 set why_msg "missing runtime threads library"
5746 pass "successfully compiled posix threads test case"
5752 if {!$built_binfile} {
5753 unsupported "couldn't compile [file tail $source]: ${why_msg}"
5758 # Build a shared library from SOURCES.
5760 proc gdb_compile_shlib_1 {sources dest options} {
5761 set obj_options $options
5764 if { [lsearch -exact $options "ada"] >= 0 } {
5768 if { [lsearch -exact $options "c++"] >= 0 } {
5769 set info_options "c++"
5770 } elseif { [lsearch -exact $options "f90"] >= 0 } {
5771 set info_options "f90"
5773 set info_options "c"
5776 switch -glob [test_compiler_info "" ${info_options}] {
5778 lappend obj_options "additional_flags=-qpic"
5781 if { [istarget "*-*-cygwin*"]
5782 || [istarget "*-*-mingw*"] } {
5783 lappend obj_options "additional_flags=-fPIC"
5785 lappend obj_options "additional_flags=-fpic"
5789 if { [istarget "powerpc*-*-aix*"]
5790 || [istarget "rs6000*-*-aix*"]
5791 || [istarget "*-*-cygwin*"]
5792 || [istarget "*-*-mingw*"]
5793 || [istarget "*-*-pe*"] } {
5794 lappend obj_options "additional_flags=-fPIC"
5796 lappend obj_options "additional_flags=-fpic"
5800 lappend obj_options "additional_flags=-fpic"
5803 # don't know what the compiler is...
5804 lappend obj_options "additional_flags=-fPIC"
5808 set outdir [file dirname $dest]
5810 foreach source $sources {
5811 if {[file extension $source] == ".o"} {
5812 # Already a .o file.
5813 lappend objects $source
5817 set sourcebase [file tail $source]
5820 # Gnatmake doesn't like object name foo.adb.o, use foo.o.
5821 set sourcebase [file rootname $sourcebase]
5823 set object ${outdir}/${sourcebase}.o
5826 # Use gdb_compile_ada_1 instead of gdb_compile_ada to avoid the
5828 if {[gdb_compile_ada_1 $source $object object \
5829 $obj_options] != ""} {
5833 if {[gdb_compile $source $object object \
5834 $obj_options] != ""} {
5839 lappend objects $object
5842 set link_options $options
5844 # If we try to use gnatmake for the link, it will interpret the
5845 # object file as an .adb file. Remove ada from the options to
5847 set idx [lsearch $link_options "ada"]
5848 set link_options [lreplace $link_options $idx $idx]
5850 if [test_compiler_info "xlc-*"] {
5851 lappend link_options "additional_flags=-qmkshrobj"
5853 lappend link_options "additional_flags=-shared"
5855 if { ([istarget "*-*-mingw*"]
5856 || [istarget *-*-cygwin*]
5857 || [istarget *-*-pe*]) } {
5858 if { [is_remote host] } {
5859 set name [file tail ${dest}]
5863 lappend link_options "ldflags=-Wl,--out-implib,${name}.a"
5865 # Set the soname of the library. This causes the linker on ELF
5866 # systems to create the DT_NEEDED entry in the executable referring
5867 # to the soname of the library, and not its absolute path. This
5868 # (using the absolute path) would be problem when testing on a
5871 # In conjunction with setting the soname, we add the special
5872 # rpath=$ORIGIN value when building the executable, so that it's
5873 # able to find the library in its own directory.
5874 set destbase [file tail $dest]
5875 lappend link_options "ldflags=-Wl,-soname,$destbase"
5878 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
5881 if { [is_remote host]
5882 && ([istarget "*-*-mingw*"]
5883 || [istarget *-*-cygwin*]
5884 || [istarget *-*-pe*]) } {
5885 set dest_tail_name [file tail ${dest}]
5886 remote_upload host $dest_tail_name.a ${dest}.a
5887 remote_file host delete $dest_tail_name.a
5893 # Ignore FLAGS in target board multilib_flags while executing BODY.
5895 proc with_multilib_flags_filtered { flags body } {
5898 # Ignore flags in multilib_flags.
5899 set board [target_info name]
5900 set multilib_flags_orig [board_info $board multilib_flags]
5901 set multilib_flags ""
5902 foreach op $multilib_flags_orig {
5903 if { [lsearch -exact $flags $op] == -1 } {
5904 append multilib_flags " $op"
5908 save_target_board_info { multilib_flags } {
5909 unset_board_info multilib_flags
5910 set_board_info multilib_flags "$multilib_flags"
5911 set result [uplevel 1 $body]
5917 # Ignore PIE-related flags in target board multilib_flags while executing BODY.
5919 proc with_PIE_multilib_flags_filtered { body } {
5920 set pie_flags [list "-pie" "-no-pie" "-fPIE" "-fno-PIE"]
5921 return [uplevel 1 [list with_multilib_flags_filtered $pie_flags $body]]
5924 # Build a shared library from SOURCES. Ignore target boards PIE-related
5927 proc gdb_compile_shlib {sources dest options} {
5928 with_PIE_multilib_flags_filtered {
5929 set result [gdb_compile_shlib_1 $sources $dest $options]
5935 # This is just like gdb_compile_shlib, above, except that it tries compiling
5936 # against several different thread libraries, to see which one this
5938 proc gdb_compile_shlib_pthreads {sources dest options} {
5940 set why_msg "unrecognized error"
5941 foreach lib {-lpthreads -lpthread -lthread ""} {
5942 # This kind of wipes out whatever libs the caller may have
5943 # set. Or maybe theirs will override ours. How infelicitous.
5944 set options_with_lib [concat $options [list libs=$lib quiet]]
5945 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
5946 switch -regexp -- $ccout {
5947 ".*no posix threads support.*" {
5948 set why_msg "missing threads include file"
5951 ".*cannot open -lpthread.*" {
5952 set why_msg "missing runtime threads library"
5954 ".*Can't find library for -lpthread.*" {
5955 set why_msg "missing runtime threads library"
5958 pass "successfully compiled posix threads shlib test case"
5964 if {!$built_binfile} {
5965 unsupported "couldn't compile $sources: ${why_msg}"
5970 # This is just like gdb_compile_pthreads, above, except that we always add the
5971 # objc library for compiling Objective-C programs
5972 proc gdb_compile_objc {source dest type options} {
5974 set why_msg "unrecognized error"
5975 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
5976 # This kind of wipes out whatever libs the caller may have
5977 # set. Or maybe theirs will override ours. How infelicitous.
5978 if { $lib == "solaris" } {
5979 set lib "-lpthread -lposix4"
5981 if { $lib != "-lobjc" } {
5982 set lib "-lobjc $lib"
5984 set options_with_lib [concat $options [list libs=$lib quiet]]
5985 set ccout [gdb_compile $source $dest $type $options_with_lib]
5986 switch -regexp -- $ccout {
5987 ".*no posix threads support.*" {
5988 set why_msg "missing threads include file"
5991 ".*cannot open -lpthread.*" {
5992 set why_msg "missing runtime threads library"
5994 ".*Can't find library for -lpthread.*" {
5995 set why_msg "missing runtime threads library"
5998 pass "successfully compiled objc with posix threads test case"
6004 if {!$built_binfile} {
6005 unsupported "couldn't compile [file tail $source]: ${why_msg}"
6010 # Build an OpenMP program from SOURCE. See prefatory comment for
6011 # gdb_compile, above, for discussion of the parameters to this proc.
6013 proc gdb_compile_openmp {source dest type options} {
6014 lappend options "additional_flags=-fopenmp"
6015 return [gdb_compile $source $dest $type $options]
6018 # Send a command to GDB.
6019 # For options for TYPE see gdb_stdin_log_write
6021 proc send_gdb { string {type standard}} {
6022 gdb_stdin_log_write $string $type
6023 return [remote_send host "$string"]
6026 # Send STRING to the inferior's terminal.
6028 proc send_inferior { string } {
6029 global inferior_spawn_id
6031 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
6041 proc gdb_expect { args } {
6042 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
6043 set atimeout [lindex $args 0]
6044 set expcode [list [lindex $args 1]]
6049 # A timeout argument takes precedence, otherwise of all the timeouts
6050 # select the largest.
6051 if [info exists atimeout] {
6054 set tmt [get_largest_timeout]
6058 {uplevel remote_expect host $tmt $expcode} string]
6061 global errorInfo errorCode
6063 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
6065 return -code $code $string
6069 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
6071 # Check for long sequence of output by parts.
6072 # TEST: is the test message to be printed with the test success/fail.
6073 # SENTINEL: Is the terminal pattern indicating that output has finished.
6074 # LIST: is the sequence of outputs to match.
6075 # If the sentinel is recognized early, it is considered an error.
6078 # 1 if the test failed,
6079 # 0 if the test passes,
6080 # -1 if there was an internal error.
6082 proc gdb_expect_list {test sentinel list} {
6087 while { ${index} < [llength ${list}] } {
6088 set pattern [lindex ${list} ${index}]
6089 set index [expr ${index} + 1]
6090 verbose -log "gdb_expect_list pattern: /$pattern/" 2
6091 if { ${index} == [llength ${list}] } {
6094 -re "${pattern}${sentinel}" {
6095 # pass "${test}, pattern ${index} + sentinel"
6098 fail "${test} (pattern ${index} + sentinel)"
6101 -re ".*A problem internal to GDB has been detected" {
6102 fail "${test} (GDB internal error)"
6104 gdb_internal_error_resync
6107 fail "${test} (pattern ${index} + sentinel) (timeout)"
6112 # unresolved "${test}, pattern ${index} + sentinel"
6118 # pass "${test}, pattern ${index}"
6121 fail "${test} (pattern ${index})"
6124 -re ".*A problem internal to GDB has been detected" {
6125 fail "${test} (GDB internal error)"
6127 gdb_internal_error_resync
6130 fail "${test} (pattern ${index}) (timeout)"
6135 # unresolved "${test}, pattern ${index}"
6147 # Spawn the gdb process.
6149 # This doesn't expect any output or do any other initialization,
6150 # leaving those to the caller.
6152 # Overridable function -- you can override this function in your
6155 proc gdb_spawn { } {
6159 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
6161 proc gdb_spawn_with_cmdline_opts { cmdline_flags } {
6164 save_vars { GDBFLAGS } {
6165 if {$GDBFLAGS != ""} {
6168 append GDBFLAGS $cmdline_flags
6176 # Start gdb running, wait for prompt, and disable the pagers.
6178 # Overridable function -- you can override this function in your
6181 proc gdb_start { } {
6186 catch default_gdb_exit
6189 # Helper function for can_spawn_for_attach. Try to spawn and attach, and
6190 # return 0 only if we cannot attach because it's unsupported.
6192 gdb_caching_proc can_spawn_for_attach_1 {} {
6193 # For the benefit of gdb-caching-proc-consistency.exp, which
6194 # calls can_spawn_for_attach_1 directly. Keep in sync with
6195 # can_spawn_for_attach.
6196 if { [is_remote target] || [target_info exists use_gdb_stub] } {
6203 set me "can_spawn_for_attach"
6214 if {![gdb_simple_compile $me $src executable]} {
6218 set test_spawn_id [spawn_wait_for_attach_1 $obj]
6219 remote_file build delete $obj
6223 set test_pid [spawn_id_get_pid $test_spawn_id]
6224 set attaching_re "Attaching to process $test_pid"
6225 gdb_test_multiple "attach $test_pid" "can spawn for attach" {
6226 -re -wrap "$attaching_re\r\n.*ptrace: Operation not permitted\\." {
6231 # Don't know, keep assuming yes.
6237 kill_wait_spawned_process $test_spawn_id
6242 # Return true if we can spawn a program on the target and attach to
6243 # it. Calls gdb_exit for the first call in a test-case.
6245 proc can_spawn_for_attach { } {
6246 # We use exp_pid to get the inferior's pid, assuming that gives
6247 # back the pid of the program. On remote boards, that would give
6248 # us instead the PID of e.g., the ssh client, etc.
6249 if {[is_remote target]} {
6250 verbose -log "can't spawn for attach (target is remote)"
6254 # The "attach" command doesn't make sense when the target is
6255 # stub-like, where GDB finds the program already started on
6256 # initial connection.
6257 if {[target_info exists use_gdb_stub]} {
6258 verbose -log "can't spawn for attach (target is stub)"
6262 # The normal sequence to use for a runtime test like
6263 # can_spawn_for_attach_1 is:
6264 # - gdb_exit (don't use a running gdb, we don't know what state it is in),
6265 # - gdb_start (start a new gdb), and
6266 # - gdb_exit (cleanup).
6268 # By making can_spawn_for_attach_1 a gdb_caching_proc, we make it
6269 # unpredictable which test-case will call it first, and consequently a
6270 # test-case may pass in say a full test run, but fail when run
6271 # individually, due to a can_spawn_for_attach call in a location where a
6272 # gdb_exit (as can_spawn_for_attach_1 does) breaks things.
6273 # To avoid this, we move the initial gdb_exit out of
6274 # can_spawn_for_attach_1, guaranteeing that we end up in the same state
6275 # regardless of whether can_spawn_for_attach_1 is called. However, that
6276 # is only necessary for the first call in a test-case, so cache the result
6277 # in a global (which should be reset after each test-case) to keep track
6280 # In summary, we distinguish between three cases:
6281 # - first call in first test-case. Executes can_spawn_for_attach_1.
6282 # Calls gdb_exit, gdb_start, gdb_exit.
6283 # - first call in following test-cases. Uses cached result of
6284 # can_spawn_for_attach_1. Calls gdb_exit.
6285 # - rest. Use cached result in cache_can_spawn_for_attach_1. Calls no
6286 # gdb_start or gdb_exit.
6287 global cache_can_spawn_for_attach_1
6288 if { [info exists cache_can_spawn_for_attach_1] } {
6289 return $cache_can_spawn_for_attach_1
6293 set cache_can_spawn_for_attach_1 [can_spawn_for_attach_1]
6294 return $cache_can_spawn_for_attach_1
6297 # Centralize the failure checking of "attach" command.
6298 # Return 0 if attach failed, otherwise return 1.
6300 proc gdb_attach { testpid args } {
6305 if { [llength $args] != 0 } {
6306 error "Unexpected arguments: $args"
6309 gdb_test_multiple "attach $testpid" "attach" {
6310 -re -wrap "Attaching to.*ptrace: Operation not permitted\\." {
6311 unsupported "$gdb_test_name (Operation not permitted)"
6314 -re -wrap "$pattern" {
6323 # Start gdb with "--pid $TESTPID" on the command line and wait for the prompt.
6324 # Return 1 if GDB managed to start and attach to the process, 0 otherwise.
6326 proc_with_prefix gdb_spawn_attach_cmdline { testpid } {
6327 if ![can_spawn_for_attach] {
6328 # The caller should have checked can_spawn_for_attach itself
6329 # before getting here.
6330 error "can't spawn for attach with this target/board"
6333 set test "start gdb with --pid"
6334 set res [gdb_spawn_with_cmdline_opts "-quiet --pid=$testpid"]
6340 gdb_test_multiple "" "$test" {
6341 -re -wrap "ptrace: Operation not permitted\\." {
6342 unsupported "$gdb_test_name (operation not permitted)"
6345 -re -wrap "ptrace: No such process\\." {
6346 fail "$gdb_test_name (no such process)"
6349 -re -wrap "Attaching to process $testpid\r\n.*" {
6354 # Check that we actually attached to a process, in case the
6355 # error message is not caught by the patterns above.
6356 gdb_test_multiple "info thread" "" {
6357 -re -wrap "No threads\\." {
6358 fail "$gdb_test_name (no thread)"
6369 # Kill a progress previously started with spawn_wait_for_attach, and
6370 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
6373 proc kill_wait_spawned_process { proc_spawn_id } {
6374 set pid [exp_pid -i $proc_spawn_id]
6376 verbose -log "killing ${pid}"
6377 remote_exec build "kill -9 ${pid}"
6379 verbose -log "closing ${proc_spawn_id}"
6380 catch "close -i $proc_spawn_id"
6381 verbose -log "waiting for ${proc_spawn_id}"
6383 # If somehow GDB ends up still attached to the process here, a
6384 # blocking wait hangs until gdb is killed (or until gdb / the
6385 # ptracer reaps the exit status too, but that won't happen because
6386 # something went wrong.) Passing -nowait makes expect tell Tcl to
6387 # wait for the PID in the background. That's fine because we
6388 # don't care about the exit status. */
6389 wait -nowait -i $proc_spawn_id
6390 clean_up_spawn_id target $proc_spawn_id
6393 # Returns the process id corresponding to the given spawn id.
6395 proc spawn_id_get_pid { spawn_id } {
6396 set testpid [exp_pid -i $spawn_id]
6398 if { [istarget "*-*-cygwin*"] } {
6399 # testpid is the Cygwin PID, GDB uses the Windows PID, which
6400 # might be different due to the way fork/exec works.
6401 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
6407 # Helper function for spawn_wait_for_attach and can_spawn_for_attach_1. As
6408 # spawn_wait_for_attach, but doesn't check for can_spawn_for_attach.
6410 proc spawn_wait_for_attach_1 { executable_list } {
6411 set spawn_id_list {}
6413 foreach {executable} $executable_list {
6414 # Note we use Expect's spawn, not Tcl's exec, because with
6415 # spawn we control when to wait for/reap the process. That
6416 # allows killing the process by PID without being subject to
6418 lappend spawn_id_list [remote_spawn target $executable]
6423 return $spawn_id_list
6426 # Start a set of programs running and then wait for a bit, to be sure
6427 # that they can be attached to. Return a list of processes spawn IDs,
6428 # one element for each process spawned. It's a test error to call
6429 # this when [can_spawn_for_attach] is false.
6431 proc spawn_wait_for_attach { executable_list } {
6432 if ![can_spawn_for_attach] {
6433 # The caller should have checked can_spawn_for_attach itself
6434 # before getting here.
6435 error "can't spawn for attach with this target/board"
6438 return [spawn_wait_for_attach_1 $executable_list]
6442 # gdb_load_cmd -- load a file into the debugger.
6443 # ARGS - additional args to load command.
6444 # return a -1 if anything goes wrong.
6446 proc gdb_load_cmd { args } {
6449 if [target_info exists gdb_load_timeout] {
6450 set loadtimeout [target_info gdb_load_timeout]
6452 set loadtimeout 1600
6454 send_gdb "load $args\n"
6455 verbose "Timeout is now $loadtimeout seconds" 2
6456 gdb_expect $loadtimeout {
6457 -re "Loading section\[^\r\]*\r\n" {
6460 -re "Start address\[\r\]*\r\n" {
6463 -re "Transfer rate\[\r\]*\r\n" {
6466 -re "Memory access error\[^\r\]*\r\n" {
6467 perror "Failed to load program"
6470 -re "$gdb_prompt $" {
6473 -re "(.*)\r\n$gdb_prompt " {
6474 perror "Unexpected response from 'load' -- $expect_out(1,string)"
6478 perror "Timed out trying to load $args."
6485 # Invoke "gcore". CORE is the name of the core file to write. TEST
6486 # is the name of the test case. This will return 1 if the core file
6487 # was created, 0 otherwise. If this fails to make a core file because
6488 # this configuration of gdb does not support making core files, it
6489 # will call "unsupported", not "fail". However, if this fails to make
6490 # a core file for some other reason, then it will call "fail".
6492 proc gdb_gcore_cmd {core test} {
6497 set re_unsupported \
6498 "(?:Can't create a corefile|Target does not support core file generation\\.)"
6500 with_timeout_factor 3 {
6501 gdb_test_multiple "gcore $core" $test {
6502 -re -wrap "Saved corefile .*" {
6506 -re -wrap $re_unsupported {
6515 # Load core file CORE. TEST is the name of the test case.
6516 # This will record a pass/fail for loading the core file.
6518 # 1 - core file is successfully loaded
6519 # 0 - core file loaded but has a non fatal error
6520 # -1 - core file failed to load
6522 proc gdb_core_cmd { core test } {
6525 gdb_test_multiple "core $core" "$test" {
6526 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
6529 -re " is not a core dump:.*\r\n$gdb_prompt $" {
6530 fail "$test (bad file format)"
6533 -re -wrap "[string_to_regexp $core]: No such file or directory.*" {
6534 fail "$test (file not found)"
6537 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
6538 fail "$test (incomplete note section)"
6541 -re "Core was generated by .*\r\n$gdb_prompt $" {
6545 -re ".*$gdb_prompt $" {
6550 fail "$test (timeout)"
6554 fail "unsupported output from 'core' command"
6558 # Return the filename to download to the target and load on the target
6559 # for this shared library. Normally just LIBNAME, unless shared libraries
6560 # for this target have separate link and load images.
6562 proc shlib_target_file { libname } {
6566 # Return the filename GDB will load symbols from when debugging this
6567 # shared library. Normally just LIBNAME, unless shared libraries for
6568 # this target have separate link and load images.
6570 proc shlib_symbol_file { libname } {
6574 # Return the filename to download to the target and load for this
6575 # executable. Normally just BINFILE unless it is renamed to something
6576 # else for this target.
6578 proc exec_target_file { binfile } {
6582 # Return the filename GDB will load symbols from when debugging this
6583 # executable. Normally just BINFILE unless executables for this target
6584 # have separate files for symbols.
6586 proc exec_symbol_file { binfile } {
6590 # Rename the executable file. Normally this is just BINFILE1 being renamed
6591 # to BINFILE2, but some targets require multiple binary files.
6592 proc gdb_rename_execfile { binfile1 binfile2 } {
6593 file rename -force [exec_target_file ${binfile1}] \
6594 [exec_target_file ${binfile2}]
6595 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
6596 file rename -force [exec_symbol_file ${binfile1}] \
6597 [exec_symbol_file ${binfile2}]
6601 # "Touch" the executable file to update the date. Normally this is just
6602 # BINFILE, but some targets require multiple files.
6603 proc gdb_touch_execfile { binfile } {
6604 set time [clock seconds]
6605 file mtime [exec_target_file ${binfile}] $time
6606 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
6607 file mtime [exec_symbol_file ${binfile}] $time
6611 # Override of dejagnu's remote_upload, which doesn't handle remotedir.
6613 rename remote_upload dejagnu_remote_upload
6614 proc remote_upload { dest srcfile args } {
6615 if { [is_remote $dest] && [board_info $dest exists remotedir] } {
6616 set remotedir [board_info $dest remotedir]
6617 if { ![string match "$remotedir*" $srcfile] } {
6618 # Use hardcoded '/' as separator, as in dejagnu's remote_download.
6619 set srcfile $remotedir/$srcfile
6623 return [dejagnu_remote_upload $dest $srcfile {*}$args]
6626 # Like remote_download but provides a gdb-specific behavior.
6628 # If the destination board is remote, the local file FROMFILE is transferred as
6629 # usual with remote_download to TOFILE on the remote board. The destination
6630 # filename is added to the CLEANFILES global, so it can be cleaned up at the
6633 # If the destination board is local, the destination path TOFILE is passed
6634 # through standard_output_file, and FROMFILE is copied there.
6636 # In both cases, if TOFILE is omitted, it defaults to the [file tail] of
6639 proc gdb_remote_download {dest fromfile {tofile {}}} {
6640 # If TOFILE is not given, default to the same filename as FROMFILE.
6641 if {[string length $tofile] == 0} {
6642 set tofile [file tail $fromfile]
6645 if {[is_remote $dest]} {
6646 # When the DEST is remote, we simply send the file to DEST.
6647 global cleanfiles_target cleanfiles_host
6649 set destname [remote_download $dest $fromfile $tofile]
6650 if { $dest == "target" } {
6651 lappend cleanfiles_target $destname
6652 } elseif { $dest == "host" } {
6653 lappend cleanfiles_host $destname
6658 # When the DEST is local, we copy the file to the test directory (where
6659 # the executable is).
6661 # Note that we pass TOFILE through standard_output_file, regardless of
6662 # whether it is absolute or relative, because we don't want the tests
6663 # to be able to write outside their standard output directory.
6665 set tofile [standard_output_file $tofile]
6667 file copy -force $fromfile $tofile
6673 # Copy shlib FILE to the target.
6675 proc gdb_download_shlib { file } {
6676 set target_file [shlib_target_file $file]
6677 if { [is_remote host] } {
6678 remote_download host $target_file
6680 return [gdb_remote_download target $target_file]
6683 # Set solib-search-path to allow gdb to locate shlib FILE.
6685 proc gdb_locate_shlib { file } {
6688 if ![info exists gdb_spawn_id] {
6689 perror "gdb_load_shlib: GDB is not running"
6692 if { [is_remote target] || [is_remote host] } {
6693 # If the target or host is remote, we need to tell gdb where to find
6699 # We could set this even when not testing remotely, but a user
6700 # generally won't set it unless necessary. In order to make the tests
6701 # more like the real-life scenarios, we don't set it for local testing.
6702 if { [is_remote host] } {
6703 set solib_search_path [board_info host remotedir]
6704 if { $solib_search_path == "" } {
6705 set solib_search_path .
6708 set solib_search_path [file dirname $file]
6711 gdb_test_no_output "set solib-search-path $solib_search_path" \
6712 "set solib-search-path for [file tail $file]"
6715 # Copy shlib FILE to the target and set solib-search-path to allow gdb to
6718 proc gdb_load_shlib { file } {
6719 set dest [gdb_download_shlib $file]
6720 gdb_locate_shlib $file
6725 # gdb_load -- load a file into the debugger. Specifying no file
6726 # defaults to the executable currently being debugged.
6727 # The return value is 0 for success, -1 for failure.
6728 # Many files in config/*.exp override this procedure.
6730 proc gdb_load { arg } {
6732 return [gdb_file_cmd $arg]
6738 # with_set -- Execute BODY and set VAR temporary to VAL for the
6741 proc with_set { var val body } {
6744 "is (\[^\r\n\]+)\\."
6745 gdb_test_multiple "show $var" "" {
6746 -re -wrap $show_re {
6747 set save $expect_out(1,string)
6751 # Handle 'set to "auto" (currently "i386")'.
6752 set save [regsub {^set to} $save ""]
6753 set save [regsub {\([^\r\n]+\)$} $save ""]
6754 set save [string trim $save]
6755 set save [regsub -all {^"|"$} $save ""]
6757 if { $save == "" } {
6758 perror "Did not manage to set $var"
6761 gdb_test_multiple "set $var $val" "" {
6764 -re -wrap " is set to \"?$val\"?\\." {
6769 set code [catch {uplevel 1 $body} result]
6771 # Restore saved setting.
6772 if { $save != "" } {
6773 gdb_test_multiple "set $var $save" "" {
6776 -re -wrap "is set to \"?$save\"?( \\(\[^)\]*\\))?\\." {
6782 global errorInfo errorCode
6783 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
6785 return -code $code $result
6790 # with_complaints -- Execute BODY and set complaints temporary to N for the
6793 proc with_complaints { n body } {
6794 return [uplevel [list with_set complaints $n $body]]
6798 # gdb_load_no_complaints -- As gdb_load, but in addition verifies that
6799 # loading caused no symbol reading complaints.
6801 proc gdb_load_no_complaints { arg } {
6802 global gdb_prompt gdb_file_cmd_msg decimal
6804 # Temporarily set complaint to a small non-zero number.
6809 # Verify that there were no complaints.
6812 "^(Reading symbols from \[^\r\n\]*" \
6813 ")+(Expanding full symbols from \[^\r\n\]*" \
6815 gdb_assert {[regexp $re $gdb_file_cmd_msg]} "No complaints"
6818 # gdb_reload -- load a file into the target. Called before "running",
6819 # either the first time or after already starting the program once,
6820 # for remote targets. Most files that override gdb_load should now
6821 # override this instead.
6823 # INFERIOR_ARGS contains the arguments to pass to the inferiors, as a
6824 # single string to get interpreted by a shell. If the target board
6825 # overriding gdb_reload is a "stub", then it should arrange things such
6826 # these arguments make their way to the inferior process.
6828 proc gdb_reload { {inferior_args {}} } {
6829 # For the benefit of existing configurations, default to gdb_load.
6830 # Specifying no file defaults to the executable currently being
6832 return [gdb_load ""]
6835 proc gdb_continue { function } {
6838 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
6841 # Clean the directory containing the standard output files.
6843 proc clean_standard_output_dir {} {
6844 if { [info exists ::GDB_PERFTEST_MODE] && $::GDB_PERFTEST_MODE == "run" } {
6845 # Don't clean, use $GDB_PERFTEST_MODE == compile results.
6849 # Directory containing the standard output files.
6850 set standard_output_dir [file normalize [standard_output_file ""]]
6852 # Ensure that standard_output_dir is clean, or only contains
6853 # gdb.log / gdb.sum.
6854 set log_file_info [split [log_file -info]]
6855 set log_file [file normalize [lindex $log_file_info end]]
6856 if { $log_file == [file normalize [standard_output_file gdb.log]] } {
6857 # Dir already contains active gdb.log. Don't remove the dir, but
6858 # check that it's clean otherwise.
6859 set res [glob -directory $standard_output_dir -tails *]
6862 if { $f == "gdb.log" } {
6865 if { $f == "gdb.sum" } {
6871 error "standard output dir not clean"
6874 # Start with a clean dir.
6875 remote_exec build "rm -rf $standard_output_dir"
6880 # Default implementation of gdb_init.
6881 proc default_gdb_init { test_file_name } {
6882 global gdb_wrapper_initialized
6883 global gdb_wrapper_target
6884 global gdb_test_file_name
6885 global cleanfiles_target
6886 global cleanfiles_host
6889 # Reset the timeout value to the default. This way, any testcase
6890 # that changes the timeout value without resetting it cannot affect
6891 # the timeout used in subsequent testcases.
6892 global gdb_test_timeout
6894 set timeout $gdb_test_timeout
6896 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
6897 && [target_info exists gdb_reverse_timeout] } {
6898 set timeout [target_info gdb_reverse_timeout]
6901 # If GDB_INOTIFY is given, check for writes to '.'. This is a
6902 # debugging tool to help confirm that the test suite is
6903 # parallel-safe. You need "inotifywait" from the
6904 # inotify-tools package to use this.
6905 global GDB_INOTIFY inotify_pid
6906 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
6907 global outdir tool inotify_log_file
6909 set exclusions {outputs temp gdb[.](log|sum) cache}
6910 set exclusion_re ([join $exclusions |])
6912 set inotify_log_file [standard_temp_file inotify.out]
6913 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
6914 --exclude $exclusion_re \
6915 |& tee -a $outdir/$tool.log $inotify_log_file &]
6917 # Wait for the watches; hopefully this is long enough.
6920 # Clear the log so that we don't emit a warning the first time
6922 set fd [open $inotify_log_file w]
6926 # Block writes to all banned variables, and invocation of all
6927 # banned procedures...
6928 global banned_variables
6929 global banned_procedures
6930 global banned_traced
6931 if (!$banned_traced) {
6932 foreach banned_var $banned_variables {
6933 global "$banned_var"
6934 trace add variable "$banned_var" write error
6936 foreach banned_proc $banned_procedures {
6937 global "$banned_proc"
6938 trace add execution "$banned_proc" enter error
6943 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
6944 # messages as expected.
6949 # Don't let a .inputrc file or an existing setting of INPUTRC mess
6950 # up the test results. Certain tests (style tests and TUI tests)
6951 # want to set the terminal to a non-"dumb" value, and for those we
6952 # want to disable bracketed paste mode. Versions of Readline
6953 # before 8.0 will not understand this and will issue a warning.
6954 # We tried using a $if to guard it, but Readline 8.1 had a bug in
6955 # its version-comparison code that prevented this for working.
6956 setenv INPUTRC [cached_file inputrc "set enable-bracketed-paste off"]
6958 # This disables style output, which would interfere with many
6960 setenv NO_COLOR sorry
6962 # This setting helps detect bugs in the Python code and doesn't
6963 # seem to have a significant downside for the tests.
6964 setenv PYTHONMALLOC malloc_debug
6966 # If DEBUGINFOD_URLS is set, gdb will try to download sources and
6967 # debug info for f.i. system libraries. Prevent this.
6968 if { [is_remote host] } {
6969 # See initialization of INTERNAL_GDBFLAGS.
6971 # Using "set debuginfod enabled off" in INTERNAL_GDBFLAGS interferes
6972 # with the gdb.debuginfod test-cases, so use the unsetenv method for
6974 unset -nocomplain ::env(DEBUGINFOD_URLS)
6977 # Ensure that GDBHISTFILE and GDBHISTSIZE are removed from the
6978 # environment, we don't want these modifications to the history
6980 unset -nocomplain ::env(GDBHISTFILE)
6981 unset -nocomplain ::env(GDBHISTSIZE)
6983 # Ensure that XDG_CONFIG_HOME is not set. Some tests setup a fake
6984 # home directory in order to test loading settings from gdbinit.
6985 # If XDG_CONFIG_HOME is set then GDB will load a gdbinit from
6986 # there (if one is present) rather than the home directory setup
6988 unset -nocomplain ::env(XDG_CONFIG_HOME)
6990 # Initialize GDB's pty with a fixed size, to make sure we avoid pagination
6991 # during startup. See "man expect" for details about stty_init.
6993 set stty_init "rows 25 cols 80"
6995 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
6996 # grep. Clear GREP_OPTIONS to make the behavior predictable,
6997 # especially having color output turned on can cause tests to fail.
6998 setenv GREP_OPTIONS ""
7000 # Clear $gdbserver_reconnect_p.
7001 global gdbserver_reconnect_p
7002 set gdbserver_reconnect_p 1
7003 unset gdbserver_reconnect_p
7005 # Clear $last_loaded_file
7006 global last_loaded_file
7007 unset -nocomplain last_loaded_file
7009 # Reset GDB number of instances
7010 global gdb_instances
7013 set cleanfiles_target {}
7014 set cleanfiles_host {}
7016 set gdb_test_file_name [file rootname [file tail $test_file_name]]
7018 clean_standard_output_dir
7020 # Make sure that the wrapper is rebuilt
7021 # with the appropriate multilib option.
7022 if { $gdb_wrapper_target != [current_target_name] } {
7023 set gdb_wrapper_initialized 0
7026 # Unlike most tests, we have a small number of tests that generate
7027 # a very large amount of output. We therefore increase the expect
7028 # buffer size to be able to contain the entire test output. This
7029 # is especially needed by gdb.base/info-macros.exp.
7031 # Also set this value for the currently running GDB.
7032 match_max [match_max -d]
7034 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
7035 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
7038 if [target_info exists gdb_prompt] {
7039 set gdb_prompt [target_info gdb_prompt]
7041 set gdb_prompt "\\(gdb\\)"
7044 if [info exists use_gdb_stub] {
7048 gdb_setup_known_globals
7050 if { [info procs ::gdb_tcl_unknown] != "" } {
7051 # Dejagnu overrides proc unknown. The dejagnu version may trigger in a
7052 # test-case but abort the entire test run. To fix this, we install a
7053 # local version here, which reverts dejagnu's override, and restore
7054 # dejagnu's version in gdb_finish.
7055 rename ::unknown ::dejagnu_unknown
7056 proc unknown { args } {
7057 # Use tcl's unknown.
7058 set cmd [lindex $args 0]
7059 unresolved "testcase aborted due to invalid command name: $cmd"
7060 return [uplevel 1 ::gdb_tcl_unknown $args]
7064 # Dejagnu version 1.6.3 and later produce an unresolved at the end of a
7065 # testcase if an error triggered, resetting errcnt and warncnt to 0, in
7066 # order to avoid errors in one test-case influencing the following
7067 # test-case. Do this manually here, to support older versions.
7074 # Return a path using GDB_PARALLEL.
7075 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
7076 # GDB_PARALLEL must be defined, the caller must check.
7078 # The default value for GDB_PARALLEL is, canonically, ".".
7079 # The catch is that tests don't expect an additional "./" in file paths so
7080 # omit any directory for the default case.
7081 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
7082 # its special handling.
7084 proc make_gdb_parallel_path { args } {
7085 global GDB_PARALLEL objdir
7086 set joiner [list "file" "join" $objdir]
7087 if { [info exists GDB_PARALLEL] && $GDB_PARALLEL != "yes" } {
7088 lappend joiner $GDB_PARALLEL
7090 set joiner [concat $joiner $args]
7091 return [eval $joiner]
7094 # Turn BASENAME into a full file name in the standard output
7095 # directory. It is ok if BASENAME is the empty string; in this case
7096 # the directory is returned.
7098 proc standard_output_file {basename} {
7099 global objdir subdir gdb_test_file_name
7101 set dir [make_gdb_parallel_path outputs $subdir $gdb_test_file_name]
7103 # If running on MinGW, replace /c/foo with c:/foo
7104 if { [ishost *-*-mingw*] } {
7105 set dir [exec sh -c "cd ${dir} && pwd -W"]
7107 return [file join $dir $basename]
7110 # Turn BASENAME into a file name on host.
7112 proc host_standard_output_file { basename } {
7113 if { [is_remote host] } {
7114 set remotedir [board_info host remotedir]
7115 if { $remotedir == "" } {
7116 if { $basename == "" } {
7121 return [join [list $remotedir $basename] "/"]
7124 return [standard_output_file $basename]
7128 # Turn BASENAME into a full file name in the standard output directory. If
7129 # GDB has been launched more than once then append the count, starting with
7132 proc standard_output_file_with_gdb_instance {basename} {
7133 global gdb_instances
7134 set count $gdb_instances
7137 return [standard_output_file $basename]
7139 return [standard_output_file ${basename}.${count}]
7142 # Return the name of a file in our standard temporary directory.
7144 proc standard_temp_file {basename} {
7145 # Since a particular runtest invocation is only executing a single test
7146 # file at any given time, we can use the runtest pid to build the
7147 # path of the temp directory.
7148 set dir [make_gdb_parallel_path temp [pid]]
7150 return [file join $dir $basename]
7153 # Rename file A to file B, if B does not already exists. Otherwise, leave B
7154 # as is and delete A. Return 1 if rename happened.
7156 proc tentative_rename { a b } {
7157 global errorInfo errorCode
7158 set code [catch {file rename -- $a $b} result]
7159 if { $code == 1 && [lindex $errorCode 0] == "POSIX" \
7160 && [lindex $errorCode 1] == "EEXIST" } {
7165 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
7166 } elseif {$code > 1} {
7167 return -code $code $result
7172 # Create a file with name FILENAME and contents TXT in the cache directory.
7173 # If EXECUTABLE, mark the new file for execution.
7175 proc cached_file { filename txt {executable 0}} {
7176 set filename [make_gdb_parallel_path cache $filename]
7178 if { [file exists $filename] } {
7182 set dir [file dirname $filename]
7185 set tmp_filename $filename.[pid]
7186 set fd [open $tmp_filename w]
7190 if { $executable } {
7191 exec chmod +x $tmp_filename
7193 tentative_rename $tmp_filename $filename
7198 # Return a wrapper around gdb that prevents generating a core file.
7200 proc gdb_no_core { } {
7204 [join [list exec $::GDB {"$@"}]]]
7205 set script [join $script "\n"]
7206 return [cached_file gdb-no-core.sh $script 1]
7209 # Set 'testfile', 'srcfile', and 'binfile'.
7211 # ARGS is a list of source file specifications.
7212 # Without any arguments, the .exp file's base name is used to
7213 # compute the source file name. The ".c" extension is added in this case.
7214 # If ARGS is not empty, each entry is a source file specification.
7215 # If the specification starts with a "." or "-", it is treated as a suffix
7216 # to append to the .exp file's base name.
7217 # If the specification is the empty string, it is treated as if it
7219 # Otherwise it is a file name.
7220 # The first file in the list is used to set the 'srcfile' global.
7221 # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
7223 # Most tests should call this without arguments.
7225 # If a completely different binary file name is needed, then it
7226 # should be handled in the .exp file with a suitable comment.
7228 proc standard_testfile {args} {
7229 global gdb_test_file_name
7231 global gdb_test_file_last_vars
7234 global testfile binfile
7236 set testfile $gdb_test_file_name
7237 set binfile [standard_output_file ${testfile}]
7239 if {[llength $args] == 0} {
7243 # Unset our previous output variables.
7244 # This can help catch hidden bugs.
7245 if {[info exists gdb_test_file_last_vars]} {
7246 foreach varname $gdb_test_file_last_vars {
7248 catch {unset $varname}
7251 # 'executable' is often set by tests.
7252 set gdb_test_file_last_vars {executable}
7256 set varname srcfile$suffix
7259 # Handle an extension.
7263 set first [string range $arg 0 0]
7264 if { $first == "." || $first == "-" } {
7265 set arg $testfile$arg
7270 lappend gdb_test_file_last_vars $varname
7272 if {$suffix == ""} {
7280 # The default timeout used when testing GDB commands. We want to use
7281 # the same timeout as the default dejagnu timeout, unless the user has
7282 # already provided a specific value (probably through a site.exp file).
7283 global gdb_test_timeout
7284 if ![info exists gdb_test_timeout] {
7285 set gdb_test_timeout $timeout
7288 # A list of global variables that GDB testcases should not use.
7289 # We try to prevent their use by monitoring write accesses and raising
7290 # an error when that happens.
7291 set banned_variables { bug_id prms_id }
7293 # A list of procedures that GDB testcases should not use.
7294 # We try to prevent their use by monitoring invocations and raising
7295 # an error when that happens.
7296 set banned_procedures { strace }
7298 # gdb_init is called by runtest at start, but also by several
7299 # tests directly; gdb_finish is only called from within runtest after
7300 # each test source execution.
7301 # Placing several traces by repetitive calls to gdb_init leads
7302 # to problems, as only one trace is removed in gdb_finish.
7303 # To overcome this possible problem, we add a variable that records
7304 # if the banned variables and procedures are already traced.
7307 # Global array that holds the name of all global variables at the time
7308 # a test script is started. After the test script has completed any
7309 # global not in this list is deleted.
7310 array set gdb_known_globals {}
7312 # Setup the GDB_KNOWN_GLOBALS array with the names of all current
7314 proc gdb_setup_known_globals {} {
7315 global gdb_known_globals
7317 array set gdb_known_globals {}
7318 foreach varname [info globals] {
7319 set gdb_known_globals($varname) 1
7323 # Cleanup the global namespace. Any global not in the
7324 # GDB_KNOWN_GLOBALS array is unset, this ensures we don't "leak"
7325 # globals from one test script to another.
7326 proc gdb_cleanup_globals {} {
7327 global gdb_known_globals gdb_persistent_globals
7329 foreach varname [info globals] {
7330 if {![info exists gdb_known_globals($varname)]} {
7331 if { [info exists gdb_persistent_globals($varname)] } {
7334 uplevel #0 unset $varname
7339 # Create gdb_tcl_unknown, a copy tcl's ::unknown, provided it's present as a
7341 set temp [interp create]
7342 if { [interp eval $temp "info procs ::unknown"] != "" } {
7343 set old_args [interp eval $temp "info args ::unknown"]
7344 set old_body [interp eval $temp "info body ::unknown"]
7345 eval proc gdb_tcl_unknown {$old_args} {$old_body}
7350 # GDB implementation of ${tool}_init. Called right before executing the
7352 # Overridable function -- you can override this function in your
7354 proc gdb_init { args } {
7355 # A baseboard file overriding this proc and calling the default version
7356 # should behave the same as this proc. So, don't add code here, but to
7357 # the default version instead.
7358 return [default_gdb_init {*}$args]
7361 # GDB implementation of ${tool}_finish. Called right after executing the
7363 proc gdb_finish { } {
7364 global gdbserver_reconnect_p
7366 global cleanfiles_target
7367 global cleanfiles_host
7368 global known_globals
7370 if { [info procs ::gdb_tcl_unknown] != "" } {
7371 # Restore dejagnu's version of proc unknown.
7373 rename ::dejagnu_unknown ::unknown
7376 # Exit first, so that the files are no longer in use.
7379 if { [llength $cleanfiles_target] > 0 } {
7380 eval remote_file target delete $cleanfiles_target
7381 set cleanfiles_target {}
7383 if { [llength $cleanfiles_host] > 0 } {
7384 eval remote_file host delete $cleanfiles_host
7385 set cleanfiles_host {}
7388 # Unblock write access to the banned variables. Dejagnu typically
7389 # resets some of them between testcases.
7390 global banned_variables
7391 global banned_procedures
7392 global banned_traced
7393 if ($banned_traced) {
7394 foreach banned_var $banned_variables {
7395 global "$banned_var"
7396 trace remove variable "$banned_var" write error
7398 foreach banned_proc $banned_procedures {
7399 global "$banned_proc"
7400 trace remove execution "$banned_proc" enter error
7405 global gdb_finish_hooks
7406 foreach gdb_finish_hook $gdb_finish_hooks {
7409 set gdb_finish_hooks [list]
7415 set debug_format "unknown"
7417 # Run the gdb command "info source" and extract the debugging format
7418 # information from the output and save it in debug_format.
7420 proc get_debug_format { } {
7425 set debug_format "unknown"
7426 send_gdb "info source\n"
7428 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
7429 set debug_format $expect_out(1,string)
7430 verbose "debug format is $debug_format"
7433 -re "No current source file.\r\n$gdb_prompt $" {
7434 perror "get_debug_format used when no current source file"
7437 -re "$gdb_prompt $" {
7438 warning "couldn't check debug format (no valid response)."
7442 warning "couldn't check debug format (timeout)."
7448 # Return true if FORMAT matches the debug format the current test was
7449 # compiled with. FORMAT is a shell-style globbing pattern; it can use
7450 # `*', `[...]', and so on.
7452 # This function depends on variables set by `get_debug_format', above.
7454 proc test_debug_format {format} {
7457 return [expr [string match $format $debug_format] != 0]
7460 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
7461 # COFF, stabs, etc). If that format matches the format that the
7462 # current test was compiled with, then the next test is expected to
7463 # fail for any target. Returns 1 if the next test or set of tests is
7464 # expected to fail, 0 otherwise (or if it is unknown). Must have
7465 # previously called get_debug_format.
7466 proc setup_xfail_format { format } {
7467 set ret [test_debug_format $format]
7475 # gdb_get_line_number TEXT [FILE]
7477 # Search the source file FILE, and return the line number of the
7478 # first line containing TEXT. If no match is found, an error is thrown.
7480 # TEXT is a string literal, not a regular expression.
7482 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
7483 # specified, and does not start with "/", then it is assumed to be in
7484 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
7485 # by changing the callers and the interface at the same time.
7486 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
7487 # gdb.base/ena-dis-br.exp.
7489 # Use this function to keep your test scripts independent of the
7490 # exact line numbering of the source file. Don't write:
7492 # send_gdb "break 20"
7494 # This means that if anyone ever edits your test's source file,
7495 # your test could break. Instead, put a comment like this on the
7496 # source file line you want to break at:
7498 # /* breakpoint spot: frotz.exp: test name */
7500 # and then write, in your test script (which we assume is named
7503 # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
7505 # (Yes, Tcl knows how to handle the nested quotes and brackets.
7508 # % puts "foo [lindex "bar baz" 1]"
7511 # Tcl is quite clever, for a little stringy language.)
7515 # The previous implementation of this procedure used the gdb search command.
7516 # This version is different:
7518 # . It works with MI, and it also works when gdb is not running.
7520 # . It operates on the build machine, not the host machine.
7522 # . For now, this implementation fakes a current directory of
7523 # $srcdir/$subdir to be compatible with the old implementation.
7524 # This will go away eventually and some callers will need to
7527 # . The TEXT argument is literal text and matches literally,
7528 # not a regular expression as it was before.
7530 # . State changes in gdb, such as changing the current file
7531 # and setting $_, no longer happen.
7533 # After a bit of time we can forget about the differences from the
7534 # old implementation.
7536 # --chastain 2004-08-05
7538 proc gdb_get_line_number { text { file "" } } {
7543 if {"$file" == ""} {
7546 if {![regexp "^/" "$file"]} {
7547 set file "$srcdir/$subdir/$file"
7550 if {[catch { set fd [open "$file"] } message]} {
7555 for { set line 1 } { 1 } { incr line } {
7556 if {[catch { set nchar [gets "$fd" body] } message]} {
7562 if {[string first "$text" "$body"] >= 0} {
7568 if {[catch { close "$fd" } message]} {
7573 error "undefined tag \"$text\""
7579 # Continue the program until it ends.
7581 # MSSG is the error message that gets printed. If not given, a
7583 # COMMAND is the command to invoke. If not given, "continue" is
7585 # ALLOW_EXTRA is a flag indicating whether the test should expect
7586 # extra output between the "Continuing." line and the program
7587 # exiting. By default it is zero; if nonzero, any extra output
7590 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
7591 global inferior_exited_re use_gdb_stub
7594 set text "continue until exit"
7596 set text "continue until exit at $mssg"
7601 } elseif {[istarget *-*-cygwin*] || [istarget *-*-mingw*]} {
7602 # On Windows, even on supposedly single-threaded programs, we
7603 # may see thread exit output when running to end, for threads
7604 # spawned by the runtime. E.g.:
7608 # [Thread 14364.0x21d4 exited with code 0]
7609 # [Thread 14364.0x4374 exited with code 0]
7610 # [Thread 14364.0x3aec exited with code 0]
7611 # [Thread 14364.0x3368 exited with code 0]
7612 # [Inferior 1 (process 14364) exited normally]
7614 set extra "(\\\[Thread \[^\r\n\]+ exited with code $::decimal\\\]\r\n)*"
7619 # By default, we don't rely on exit() behavior of remote stubs --
7620 # it's common for exit() to be implemented as a simple infinite
7621 # loop, or a forced crash/reset. For native targets, by default, we
7622 # assume process exit is reported as such. If a non-reliable target
7623 # is used, we set a breakpoint at exit, and continue to that.
7624 if { [target_info exists exit_is_reliable] } {
7625 set exit_is_reliable [target_info exit_is_reliable]
7627 set exit_is_reliable [expr ! $use_gdb_stub]
7630 if { ! $exit_is_reliable } {
7631 if {![gdb_breakpoint "exit"]} {
7634 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
7637 # Continue until we exit. Should not stop again.
7638 # Don't bother to check the output of the program, that may be
7639 # extremely tough for some remote systems.
7641 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
7646 proc rerun_to_main {} {
7647 global gdb_prompt use_gdb_stub
7652 -re ".*Breakpoint .*main .*$gdb_prompt $"\
7653 {pass "rerun to main" ; return 0}
7654 -re "$gdb_prompt $"\
7655 {fail "rerun to main" ; return 0}
7656 timeout {fail "(timeout) rerun to main" ; return 0}
7661 -re "The program .* has been started already.*y or n. $" {
7662 send_gdb "y\n" answer
7665 -re "Starting program.*$gdb_prompt $"\
7666 {pass "rerun to main" ; return 0}
7667 -re "$gdb_prompt $"\
7668 {fail "rerun to main" ; return 0}
7669 timeout {fail "(timeout) rerun to main" ; return 0}
7674 # Return true if EXECUTABLE contains a .gdb_index or .debug_names index section.
7676 proc exec_has_index_section { executable } {
7677 set readelf_program [gdb_find_readelf]
7678 set res [catch {exec $readelf_program -S $executable \
7679 | grep -E "\.gdb_index|\.debug_names" }]
7686 # Return list with major and minor version of readelf, or an empty list.
7687 gdb_caching_proc readelf_version {} {
7688 set readelf_program [gdb_find_readelf]
7689 set res [catch {exec $readelf_program --version} output]
7693 set lines [split $output \n]
7694 set line [lindex $lines 0]
7695 set res [regexp {[ \t]+([0-9]+)[.]([0-9]+)[^ \t]*$} \
7696 $line dummy major minor]
7700 return [list $major $minor]
7703 # Return 1 if readelf prints the PIE flag, 0 if is doesn't, and -1 if unknown.
7704 proc readelf_prints_pie { } {
7705 set version [readelf_version]
7706 if { [llength $version] == 0 } {
7709 set major [lindex $version 0]
7710 set minor [lindex $version 1]
7711 # It would be better to construct a PIE executable and test if the PIE
7712 # flag is printed by readelf, but we cannot reliably construct a PIE
7713 # executable if the multilib_flags dictate otherwise
7714 # (--target_board=unix/-no-pie/-fno-PIE).
7715 return [version_compare {2 26} <= [list $major $minor]]
7718 # Return 1 if EXECUTABLE is a Position Independent Executable, 0 if it is not,
7719 # and -1 if unknown.
7721 proc exec_is_pie { executable } {
7722 set res [readelf_prints_pie]
7726 set readelf_program [gdb_find_readelf]
7727 # We're not testing readelf -d | grep "FLAGS_1.*Flags:.*PIE"
7728 # because the PIE flag is not set by all versions of gold, see PR
7730 set res [catch {exec $readelf_program -h $executable} output]
7734 set res [regexp -line {^[ \t]*Type:[ \t]*DYN \((Position-Independent Executable|Shared object) file\)$} \
7742 # Return false if a test should be skipped due to lack of floating
7743 # point support or GDB can't fetch the contents from floating point
7746 gdb_caching_proc allow_float_test {} {
7747 if [target_info exists gdb,skip_float_tests] {
7751 # There is an ARM kernel ptrace bug that hardware VFP registers
7752 # are not updated after GDB ptrace set VFP registers. The bug
7753 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
7754 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
7755 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
7756 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
7757 # This kernel bug is detected by check how does GDB change the
7758 # program result by changing one VFP register.
7759 if { [istarget "arm*-*-linux*"] } {
7761 set compile_flags {debug nowarnings }
7763 # Set up, compile, and execute a test program having VFP
7765 set src [standard_temp_file arm_vfp.c]
7766 set exe [standard_temp_file arm_vfp.x]
7768 gdb_produce_source $src {
7773 asm ("vldr d0, [%0]" : : "r" (&d));
7774 asm ("vldr d1, [%0]" : : "r" (&d));
7775 asm (".global break_here\n"
7777 asm ("vcmp.f64 d0, d1\n"
7778 "vmrs APSR_nzcv, fpscr\n"
7779 "bne L_value_different\n"
7782 "L_value_different:\n"
7784 "L_end:\n" : "=r" (ret) :);
7786 /* Return $d0 != $d1. */
7791 verbose "compiling testfile $src" 2
7792 set lines [gdb_compile $src $exe executable $compile_flags]
7795 if {![string match "" $lines]} {
7796 verbose "testfile compilation failed, returning 1" 2
7800 # No error message, compilation succeeded so now run it via gdb.
7801 # Run the test up to 5 times to detect whether ptrace can
7802 # correctly update VFP registers or not.
7803 set allow_vfp_test 1
7804 for {set i 0} {$i < 5} {incr i} {
7805 global gdb_prompt srcdir subdir
7809 gdb_reinitialize_dir $srcdir/$subdir
7813 gdb_test "break *break_here"
7814 gdb_continue_to_breakpoint "break_here"
7816 # Modify $d0 to a different value, so the exit code should
7818 gdb_test "set \$d0 = 5.0"
7820 set test "continue to exit"
7821 gdb_test_multiple "continue" "$test" {
7822 -re "exited with code 01.*$gdb_prompt $" {
7824 -re "exited normally.*$gdb_prompt $" {
7825 # However, the exit code is 0. That means something
7826 # wrong in setting VFP registers.
7827 set allow_vfp_test 0
7834 remote_file build delete $exe
7836 return $allow_vfp_test
7841 # Print a message and return true if a test should be skipped
7842 # due to lack of stdio support.
7844 proc gdb_skip_stdio_test { msg } {
7845 if [target_info exists gdb,noinferiorio] {
7846 verbose "Skipping test '$msg': no inferior i/o."
7852 proc gdb_skip_bogus_test { msg } {
7856 # Return true if XML support is enabled in the host GDB.
7857 # NOTE: This must be called while gdb is *not* running.
7859 gdb_caching_proc allow_xml_test {} {
7864 if { [info exists gdb_spawn_id] } {
7865 error "GDB must not be running in allow_xml_tests."
7868 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
7872 gdb_test_multiple "set tdesc filename $xml_file" "" {
7873 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
7876 -re ".*$gdb_prompt $" { }
7879 return [expr {!$xml_missing}]
7882 # Return true if argv[0] is available.
7884 gdb_caching_proc gdb_has_argv0 {} {
7887 # Compile and execute a test program to check whether argv[0] is available.
7888 gdb_simple_compile has_argv0 {
7889 int main (int argc, char **argv) {
7896 proc gdb_has_argv0_1 { exe } {
7897 global srcdir subdir
7898 global gdb_prompt hex
7902 gdb_reinitialize_dir $srcdir/$subdir
7905 # Set breakpoint on main.
7906 gdb_test_multiple "break -q main" "break -q main" {
7907 -re "Breakpoint.*${gdb_prompt} $" {
7909 -re "${gdb_prompt} $" {
7916 gdb_test_multiple "" "run to main" {
7917 -re "Breakpoint.*${gdb_prompt} $" {
7919 -re "${gdb_prompt} $" {
7924 set old_elements "200"
7925 set test "show print elements"
7926 gdb_test_multiple $test $test {
7927 -re "Limit on string chars or array elements to print is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
7928 set old_elements $expect_out(1,string)
7931 set old_repeats "200"
7932 set test "show print repeats"
7933 gdb_test_multiple $test $test {
7934 -re "Threshold for repeated print elements is (\[^\r\n\]+)\\.\r\n$gdb_prompt $" {
7935 set old_repeats $expect_out(1,string)
7938 gdb_test_no_output "set print elements unlimited" ""
7939 gdb_test_no_output "set print repeats unlimited" ""
7942 # Check whether argc is 1.
7943 gdb_test_multiple "p argc" "p argc" {
7944 -re " = 1\r\n${gdb_prompt} $" {
7946 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
7947 -re " = $hex \".*[file tail $exe]\"\r\n${gdb_prompt} $" {
7950 -re "${gdb_prompt} $" {
7954 -re "${gdb_prompt} $" {
7958 gdb_test_no_output "set print elements $old_elements" ""
7959 gdb_test_no_output "set print repeats $old_repeats" ""
7964 set result [gdb_has_argv0_1 $obj]
7970 && ([istarget *-*-linux*]
7971 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
7972 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
7973 || [istarget *-*-openbsd*]
7974 || [istarget *-*-darwin*]
7975 || [istarget *-*-solaris*]
7976 || [istarget *-*-aix*]
7977 || [istarget *-*-gnu*]
7978 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
7979 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
7980 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
7981 || [istarget *-*-osf*]
7982 || [istarget *-*-dicos*]
7983 || [istarget *-*-nto*]
7984 || [istarget *-*-*vms*]
7985 || [istarget *-*-lynx*178]) } {
7986 fail "argv\[0\] should be available on this target"
7992 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
7993 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
7994 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
7995 # the name of a debuginfo only file. This file will be stored in the same
7998 # Functions for separate debug info testing
8000 # starting with an executable:
8001 # foo --> original executable
8003 # at the end of the process we have:
8004 # foo.stripped --> foo w/o debug info
8005 # foo.debug --> foo's debug info
8006 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
8008 # Fetch the build id from the file.
8009 # Returns "" if there is none.
8011 proc get_build_id { filename } {
8012 if { ([istarget "*-*-mingw*"]
8013 || [istarget *-*-cygwin*]) } {
8014 set objdump_program [gdb_find_objdump]
8015 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
8016 verbose "result is $result"
8017 verbose "output is $output"
8023 set tmp [standard_output_file "${filename}-tmp"]
8024 set objcopy_program [gdb_find_objcopy]
8025 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
8026 verbose "result is $result"
8027 verbose "output is $output"
8032 fconfigure $fi -translation binary
8033 # Skip the NOTE header.
8038 if {![string compare $data ""]} {
8041 # Convert it to hex.
8042 binary scan $data H* data
8047 # Return the build-id hex string (usually 160 bits as 40 hex characters)
8048 # converted to the form: .build-id/ab/cdef1234...89.debug
8049 # Return "" if no build-id found.
8050 proc build_id_debug_filename_get { filename } {
8051 set data [get_build_id $filename]
8052 if { $data == "" } {
8055 regsub {^..} $data {\0/} data
8056 return ".build-id/${data}.debug"
8059 # DEST should be a file compiled with debug information. This proc
8060 # creates two new files DEST.debug which contains the debug
8061 # information extracted from DEST, and DEST.stripped, which is a copy
8062 # of DEST with the debug information removed. A '.gnu_debuglink'
8063 # section will be added to DEST.stripped that points to DEST.debug.
8065 # If ARGS is passed, it is a list of optional flags. The currently
8066 # supported flags are:
8068 # - no-main : remove the symbol entry for main from the separate
8069 # debug file DEST.debug,
8070 # - no-debuglink : don't add the '.gnu_debuglink' section to
8073 # Function returns zero on success. Function will return non-zero failure code
8074 # on some targets not supporting separate debug info (such as i386-msdos).
8076 proc gdb_gnu_strip_debug { dest args } {
8078 # Use the first separate debug info file location searched by GDB so the
8079 # run cannot be broken by some stale file searched with higher precedence.
8080 set debug_file "${dest}.debug"
8082 set strip_to_file_program [transform strip]
8083 set objcopy_program [gdb_find_objcopy]
8085 set debug_link [file tail $debug_file]
8086 set stripped_file "${dest}.stripped"
8088 # Get rid of the debug info, and store result in stripped_file
8089 # something like gdb/testsuite/gdb.base/blah.stripped.
8090 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
8091 verbose "result is $result"
8092 verbose "output is $output"
8097 # Workaround PR binutils/10802:
8098 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
8099 set perm [file attributes ${dest} -permissions]
8100 file attributes ${stripped_file} -permissions $perm
8102 # Get rid of everything but the debug info, and store result in debug_file
8103 # This will be in the .debug subdirectory, see above.
8104 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
8105 verbose "result is $result"
8106 verbose "output is $output"
8111 # If no-main is passed, strip the symbol for main from the separate
8112 # file. This is to simulate the behavior of elfutils's eu-strip, which
8113 # leaves the symtab in the original file only. There's no way to get
8114 # objcopy or strip to remove the symbol table without also removing the
8115 # debugging sections, so this is as close as we can get.
8116 if {[lsearch -exact $args "no-main"] != -1} {
8117 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
8118 verbose "result is $result"
8119 verbose "output is $output"
8123 file delete "${debug_file}"
8124 file rename "${debug_file}-tmp" "${debug_file}"
8127 # Unless the "no-debuglink" flag is passed, then link the two
8128 # previous output files together, adding the .gnu_debuglink
8129 # section to the stripped_file, containing a pointer to the
8130 # debug_file, save the new file in dest.
8131 if {[lsearch -exact $args "no-debuglink"] == -1} {
8132 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
8133 verbose "result is $result"
8134 verbose "output is $output"
8140 # Workaround PR binutils/10802:
8141 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
8142 set perm [file attributes ${stripped_file} -permissions]
8143 file attributes ${dest} -permissions $perm
8148 # Test the output of GDB_COMMAND matches the pattern obtained
8149 # by concatenating all elements of EXPECTED_LINES. This makes
8150 # it possible to split otherwise very long string into pieces.
8151 # If third argument TESTNAME is not empty, it's used as the name of the
8152 # test to be printed on pass/fail.
8153 proc help_test_raw { gdb_command expected_lines {testname {}} } {
8154 set expected_output [join $expected_lines ""]
8155 if {$testname != {}} {
8156 gdb_test "${gdb_command}" "${expected_output}" $testname
8160 gdb_test "${gdb_command}" "${expected_output}"
8163 # A regexp that matches the end of help CLASS|PREFIX_COMMAND
8164 set help_list_trailer {
8165 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
8166 "Type \"apropos -v word\" for full documentation of commands related to \"word\"\.[\r\n]+"
8167 "Command name abbreviations are allowed if unambiguous\."
8170 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
8171 # are regular expressions that should match the beginning of output,
8172 # before the list of commands in that class.
8173 # LIST_OF_COMMANDS are regular expressions that should match the
8174 # list of commands in that class. If empty, the command list will be
8175 # matched automatically. The presence of standard epilogue will be tested
8177 # If last argument TESTNAME is not empty, it's used as the name of the
8178 # test to be printed on pass/fail.
8179 # Notice that the '[' and ']' characters don't need to be escaped for strings
8180 # wrapped in {} braces.
8181 proc test_class_help { command_class expected_initial_lines {list_of_commands {}} {testname {}} } {
8182 global help_list_trailer
8183 if {[llength $list_of_commands]>0} {
8184 set l_list_of_commands {"List of commands:[\r\n]+[\r\n]+"}
8185 set l_list_of_commands [concat $l_list_of_commands $list_of_commands]
8186 set l_list_of_commands [concat $l_list_of_commands {"[\r\n]+[\r\n]+"}]
8188 set l_list_of_commands {"List of commands\:.*[\r\n]+"}
8191 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
8193 set l_entire_body [concat $expected_initial_lines $l_list_of_commands \
8194 $l_stock_body $help_list_trailer]
8196 help_test_raw "help ${command_class}" $l_entire_body $testname
8199 # Like test_class_help but specialised to test "help user-defined".
8200 proc test_user_defined_class_help { {list_of_commands {}} {testname {}} } {
8201 test_class_help "user-defined" {
8202 "User-defined commands\.[\r\n]+"
8203 "The commands in this class are those defined by the user\.[\r\n]+"
8204 "Use the \"define\" command to define a command\.[\r\n]+"
8205 } $list_of_commands $testname
8209 # COMMAND_LIST should have either one element -- command to test, or
8210 # two elements -- abbreviated command to test, and full command the first
8211 # element is abbreviation of.
8212 # The command must be a prefix command. EXPECTED_INITIAL_LINES
8213 # are regular expressions that should match the beginning of output,
8214 # before the list of subcommands. The presence of
8215 # subcommand list and standard epilogue will be tested automatically.
8216 proc test_prefix_command_help { command_list expected_initial_lines args } {
8217 global help_list_trailer
8218 set command [lindex $command_list 0]
8219 if {[llength $command_list]>1} {
8220 set full_command [lindex $command_list 1]
8222 set full_command $command
8224 # Use 'list' and not just {} because we want variables to
8225 # be expanded in this list.
8226 set l_stock_body [list\
8227 "List of $full_command subcommands\:.*\[\r\n\]+"\
8228 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"]
8229 set l_entire_body [concat $expected_initial_lines $l_stock_body $help_list_trailer]
8230 if {[llength $args]>0} {
8231 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
8233 help_test_raw "help ${command}" $l_entire_body
8237 # Build executable named EXECUTABLE from specifications that allow
8238 # different options to be passed to different sub-compilations.
8239 # TESTNAME is the name of the test; this is passed to 'untested' if
8241 # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
8242 # contains the option "pthreads", then gdb_compile_pthreads is used.
8243 # ARGS is a flat list of source specifications, of the form:
8244 # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
8245 # Each SOURCE is compiled to an object file using its OPTIONS,
8246 # using gdb_compile.
8247 # Returns 0 on success, -1 on failure.
8248 proc build_executable_from_specs {testname executable options args} {
8252 set binfile [standard_output_file $executable]
8254 set func gdb_compile
8255 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads|openmp)$}]
8256 if {$func_index != -1} {
8257 set func "${func}_[lindex $options $func_index]"
8260 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
8261 # parameter. They also requires $sources while gdb_compile and
8262 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
8263 if [string match gdb_compile_shlib* $func] {
8265 foreach {s local_options} $args {
8266 if {[regexp "^/" "$s"]} {
8267 lappend sources_path "$s"
8269 lappend sources_path "$srcdir/$subdir/$s"
8272 set ret [$func $sources_path "${binfile}" $options]
8273 } elseif {[lsearch -exact $options rust] != -1} {
8275 foreach {s local_options} $args {
8276 if {[regexp "^/" "$s"]} {
8277 lappend sources_path "$s"
8279 lappend sources_path "$srcdir/$subdir/$s"
8282 set ret [gdb_compile_rust $sources_path "${binfile}" $options]
8286 foreach {s local_options} $args {
8287 if {![regexp "^/" "$s"]} {
8288 set s "$srcdir/$subdir/$s"
8290 if { [$func "${s}" "${binfile}${i}.o" object $local_options] != "" } {
8294 lappend objects "${binfile}${i}.o"
8297 set ret [$func $objects "${binfile}" executable $options]
8307 # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
8308 # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
8309 # to pass to untested, if something is wrong. OPTIONS are passed
8310 # to gdb_compile directly.
8311 proc build_executable { testname executable {sources ""} {options {debug}} } {
8312 if {[llength $sources]==0} {
8313 set sources ${executable}.c
8316 set arglist [list $testname $executable $options]
8317 foreach source $sources {
8318 lappend arglist $source $options
8321 return [eval build_executable_from_specs $arglist]
8324 # Starts fresh GDB binary and loads an optional executable into GDB.
8325 # Usage: clean_restart [EXECUTABLE]
8326 # EXECUTABLE is the basename of the binary.
8327 # Return -1 if starting gdb or loading the executable failed.
8329 proc clean_restart {{executable ""}} {
8337 # This is a clean restart, so reset error and warning count.
8342 # if { [gdb_start] == -1 } {
8345 # but gdb_start is a ${tool}_start proc, which doesn't have a defined
8346 # return value. So instead, we test for errcnt.
8348 if { $errcnt > 0 } {
8352 gdb_reinitialize_dir $srcdir/$subdir
8354 if {$executable != ""} {
8355 set binfile [standard_output_file ${executable}]
8356 return [gdb_load ${binfile}]
8362 # Prepares for testing by calling build_executable_full, then
8364 # TESTNAME is the name of the test.
8365 # Each element in ARGS is a list of the form
8366 # { EXECUTABLE OPTIONS SOURCE_SPEC... }
8367 # These are passed to build_executable_from_specs, which see.
8368 # The last EXECUTABLE is passed to clean_restart.
8369 # Returns 0 on success, non-zero on failure.
8370 proc prepare_for_testing_full {testname args} {
8371 foreach spec $args {
8372 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
8375 set executable [lindex $spec 0]
8377 clean_restart $executable
8381 # Prepares for testing, by calling build_executable, and then clean_restart.
8382 # Please refer to build_executable for parameter description.
8383 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
8385 if {[build_executable $testname $executable $sources $options] == -1} {
8388 clean_restart $executable
8393 # Retrieve the value of EXP in the inferior, represented in format
8394 # specified in FMT (using "printFMT"). DEFAULT is used as fallback if
8395 # print fails. TEST is the test message to use. It can be omitted,
8396 # in which case a test message is built from EXP.
8398 proc get_valueof { fmt exp default {test ""} } {
8402 set test "get valueof \"${exp}\""
8406 gdb_test_multiple "print${fmt} ${exp}" "$test" {
8407 -re -wrap "^\\$\[0-9\]* = (\[^\r\n\]*)" {
8408 set val $expect_out(1,string)
8412 fail "$test (timeout)"
8418 # Retrieve the value of local var EXP in the inferior. DEFAULT is used as
8419 # fallback if print fails. TEST is the test message to use. It can be
8420 # omitted, in which case a test message is built from EXP.
8422 proc get_local_valueof { exp default {test ""} } {
8426 set test "get local valueof \"${exp}\""
8430 gdb_test_multiple "info locals ${exp}" "$test" {
8431 -re "$exp = (\[^\r\n\]*)\r\n$gdb_prompt $" {
8432 set val $expect_out(1,string)
8436 fail "$test (timeout)"
8442 # Retrieve the value of EXP in the inferior, as a signed decimal value
8443 # (using "print /d"). DEFAULT is used as fallback if print fails.
8444 # TEST is the test message to use. It can be omitted, in which case
8445 # a test message is built from EXP.
8447 proc get_integer_valueof { exp default {test ""} } {
8451 set test "get integer valueof \"${exp}\""
8455 gdb_test_multiple "print /d ${exp}" "$test" {
8456 -re -wrap "^\\$\[0-9\]* = (\[-\]*\[0-9\]*).*" {
8457 set val $expect_out(1,string)
8461 fail "$test (timeout)"
8467 # Retrieve the value of EXP in the inferior, as an hexadecimal value
8468 # (using "print /x"). DEFAULT is used as fallback if print fails.
8469 # TEST is the test message to use. It can be omitted, in which case
8470 # a test message is built from EXP.
8472 proc get_hexadecimal_valueof { exp default {test ""} } {
8476 set test "get hexadecimal valueof \"${exp}\""
8480 gdb_test_multiple "print /x ${exp}" $test {
8481 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
8482 set val $expect_out(1,string)
8489 # Retrieve the size of TYPE in the inferior, as a decimal value. DEFAULT
8490 # is used as fallback if print fails. TEST is the test message to use.
8491 # It can be omitted, in which case a test message is 'sizeof (TYPE)'.
8493 proc get_sizeof { type default {test ""} } {
8494 return [get_integer_valueof "sizeof (${type})" $default $test]
8497 proc get_target_charset { } {
8500 gdb_test_multiple "show target-charset" "" {
8501 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
8502 return $expect_out(1,string)
8504 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
8505 return $expect_out(1,string)
8509 # Pick a reasonable default.
8510 warning "Unable to read target-charset."
8514 # Get the address of VAR.
8516 proc get_var_address { var } {
8517 global gdb_prompt hex
8519 # Match output like:
8521 # $5 = (int (*)()) 0
8522 # $6 = (int (*)()) 0x24 <function_bar>
8524 gdb_test_multiple "print &${var}" "get address of ${var}" {
8525 -re "\\\$\[0-9\]+ = \\(.*\\) (0|$hex)( <${var}>)?\[\r\n\]+${gdb_prompt} $"
8527 pass "get address of ${var}"
8528 if { $expect_out(1,string) == "0" } {
8531 return $expect_out(1,string)
8538 # Return the frame number for the currently selected frame
8539 proc get_current_frame_number {{test_name ""}} {
8542 if { $test_name == "" } {
8543 set test_name "get current frame number"
8546 gdb_test_multiple "frame" $test_name {
8547 -re "#(\[0-9\]+) .*$gdb_prompt $" {
8548 set frame_num $expect_out(1,string)
8554 # Get the current value for remotetimeout and return it.
8555 proc get_remotetimeout { } {
8559 gdb_test_multiple "show remotetimeout" "" {
8560 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
8561 return $expect_out(1,string)
8565 # Pick the default that gdb uses
8566 warning "Unable to read remotetimeout"
8570 # Set the remotetimeout to the specified timeout. Nothing is returned.
8571 proc set_remotetimeout { timeout } {
8574 gdb_test_multiple "set remotetimeout $timeout" "" {
8575 -re "$gdb_prompt $" {
8576 verbose "Set remotetimeout to $timeout\n"
8581 # Get the target's current endianness and return it.
8582 proc get_endianness { } {
8585 gdb_test_multiple "show endian" "determine endianness" {
8586 -re ".* (little|big) endian.*\r\n$gdb_prompt $" {
8588 return $expect_out(1,string)
8594 # Get the target's default endianness and return it.
8595 gdb_caching_proc target_endianness {} {
8598 set me "target_endianness"
8600 set src { int main() { return 0; } }
8601 if {![gdb_simple_compile $me $src executable]} {
8609 set res [get_endianness]
8612 remote_file build delete $obj
8617 # ROOT and FULL are file names. Returns the relative path from ROOT
8618 # to FULL. Note that FULL must be in a subdirectory of ROOT.
8619 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
8622 proc relative_filename {root full} {
8623 set root_split [file split $root]
8624 set full_split [file split $full]
8626 set len [llength $root_split]
8628 if {[eval file join $root_split]
8629 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
8630 error "$full not a subdir of $root"
8633 return [eval file join [lrange $full_split $len end]]
8636 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
8637 if {[info exists GDB_PARALLEL]} {
8638 if {[is_remote host]} {
8642 [make_gdb_parallel_path outputs] \
8643 [make_gdb_parallel_path temp] \
8644 [make_gdb_parallel_path cache]
8648 # Set the inferior's cwd to the output directory, in order to have it
8649 # dump core there. This must be called before the inferior is
8652 proc set_inferior_cwd_to_output_dir {} {
8653 # Note this sets the inferior's cwd ("set cwd"), not GDB's ("cd").
8654 # If GDB crashes, we want its core dump in gdb/testsuite/, not in
8655 # the testcase's dir, so we can detect the unexpected core at the
8656 # end of the test run.
8657 if {![is_remote host]} {
8658 set output_dir [standard_output_file ""]
8659 gdb_test_no_output "set cwd $output_dir" \
8660 "set inferior cwd to test directory"
8664 # Get the inferior's PID.
8666 proc get_inferior_pid {} {
8668 gdb_test_multiple "inferior" "get inferior pid" {
8669 -re "process (\[0-9\]*).*$::gdb_prompt $" {
8670 set pid $expect_out(1,string)
8677 # Find the kernel-produced core file dumped for the current testfile
8678 # program. PID was the inferior's pid, saved before the inferior
8679 # exited with a signal, or -1 if not known. If not on a remote host,
8680 # this assumes the core was generated in the output directory.
8681 # Returns the name of the core dump, or empty string if not found.
8683 proc find_core_file {pid} {
8684 # For non-remote hosts, since cores are assumed to be in the
8685 # output dir, which we control, we use a laxer "core.*" glob. For
8686 # remote hosts, as we don't know whether the dir is being reused
8687 # for parallel runs, we use stricter names with no globs. It is
8688 # not clear whether this is really important, but it preserves
8691 if {![is_remote host]} {
8692 lappend files core.*
8693 } elseif {$pid != -1} {
8694 lappend files core.$pid
8696 lappend files ${::testfile}.core
8699 foreach file $files {
8700 if {![is_remote host]} {
8701 set names [glob -nocomplain [standard_output_file $file]]
8702 if {[llength $names] == 1} {
8703 return [lindex $names 0]
8706 if {[remote_file host exists $file]} {
8714 # Check for production of a core file and remove it. PID is the
8715 # inferior's pid or -1 if not known. TEST is the test's message.
8717 proc remove_core {pid {test ""}} {
8719 set test "cleanup core file"
8722 set file [find_core_file $pid]
8724 remote_file host delete $file
8725 pass "$test (removed)"
8727 pass "$test (not found)"
8731 proc core_find {binfile {deletefiles {}} {arg ""}} {
8732 global objdir subdir
8734 set destcore "$binfile.core"
8735 file delete $destcore
8737 # Create a core file named "$destcore" rather than just "core", to
8738 # avoid problems with sys admin types that like to regularly prune all
8739 # files named "core" from the system.
8741 # Arbitrarily try setting the core size limit to "unlimited" since
8742 # this does not hurt on systems where the command does not work and
8743 # allows us to generate a core on systems where it does.
8745 # Some systems append "core" to the name of the program; others append
8746 # the name of the program to "core"; still others (like Linux, as of
8747 # May 2003) create cores named "core.PID". In the latter case, we
8748 # could have many core files lying around, and it may be difficult to
8749 # tell which one is ours, so let's run the program in a subdirectory.
8751 set coredir [standard_output_file coredir.[getpid]]
8753 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
8754 # remote_exec host "${binfile}"
8755 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
8756 if [remote_file build exists $i] {
8757 remote_exec build "mv $i $destcore"
8761 # Check for "core.PID", "core.EXEC.PID.HOST.TIME", etc. It's fine
8762 # to use a glob here as we're looking inside a directory we
8763 # created. Also, this procedure only works on non-remote hosts.
8764 if { $found == 0 } {
8765 set names [glob -nocomplain -directory $coredir core.*]
8766 if {[llength $names] == 1} {
8767 set corefile [file join $coredir [lindex $names 0]]
8768 remote_exec build "mv $corefile $destcore"
8772 if { $found == 0 } {
8773 # The braindamaged HPUX shell quits after the ulimit -c above
8774 # without executing ${binfile}. So we try again without the
8775 # ulimit here if we didn't find a core file above.
8776 # Oh, I should mention that any "braindamaged" non-Unix system has
8777 # the same problem. I like the cd bit too, it's really neat'n stuff.
8778 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
8779 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
8780 if [remote_file build exists $i] {
8781 remote_exec build "mv $i $destcore"
8787 # Try to clean up after ourselves.
8788 foreach deletefile $deletefiles {
8789 remote_file build delete [file join $coredir $deletefile]
8791 remote_exec build "rmdir $coredir"
8793 if { $found == 0 } {
8794 warning "can't generate a core file - core tests suppressed - check ulimit -c"
8800 # gdb_target_symbol_prefix compiles a test program and then examines
8801 # the output from objdump to determine the prefix (such as underscore)
8802 # for linker symbol prefixes.
8804 gdb_caching_proc gdb_target_symbol_prefix {} {
8805 # Compile a simple test program...
8806 set src { int main() { return 0; } }
8807 if {![gdb_simple_compile target_symbol_prefix $src executable]} {
8813 set objdump_program [gdb_find_objdump]
8814 set result [catch "exec $objdump_program --syms $obj" output]
8817 && ![regexp -lineanchor \
8818 { ([^ a-zA-Z0-9]*)main$} $output dummy prefix] } {
8819 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
8827 # Return 1 if target supports scheduler locking, otherwise return 0.
8829 gdb_caching_proc target_supports_scheduler_locking {} {
8832 set me "gdb_target_supports_scheduler_locking"
8834 set src { int main() { return 0; } }
8835 if {![gdb_simple_compile $me $src executable]} {
8844 set supports_schedule_locking -1
8845 set current_schedule_locking_mode ""
8847 set test "reading current scheduler-locking mode"
8848 gdb_test_multiple "show scheduler-locking" $test {
8849 -re "Mode for locking scheduler during execution is \"(\[\^\"\]*)\".*$gdb_prompt" {
8850 set current_schedule_locking_mode $expect_out(1,string)
8852 -re "$gdb_prompt $" {
8853 set supports_schedule_locking 0
8856 set supports_schedule_locking 0
8860 if { $supports_schedule_locking == -1 } {
8861 set test "checking for scheduler-locking support"
8862 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
8863 -re "Target '\[^'\]+' cannot support this command\..*$gdb_prompt $" {
8864 set supports_schedule_locking 0
8866 -re "$gdb_prompt $" {
8867 set supports_schedule_locking 1
8870 set supports_schedule_locking 0
8875 if { $supports_schedule_locking == -1 } {
8876 set supports_schedule_locking 0
8880 remote_file build delete $obj
8881 verbose "$me: returning $supports_schedule_locking" 2
8882 return $supports_schedule_locking
8885 # Return 1 if compiler supports use of nested functions. Otherwise,
8888 gdb_caching_proc support_nested_function_tests {} {
8889 # Compile a test program containing a nested function
8890 return [gdb_can_simple_compile nested_func {
8900 # gdb_target_symbol returns the provided symbol with the correct prefix
8901 # prepended. (See gdb_target_symbol_prefix, above.)
8903 proc gdb_target_symbol { symbol } {
8904 set prefix [gdb_target_symbol_prefix]
8905 return "${prefix}${symbol}"
8908 # gdb_target_symbol_prefix_flags_asm returns a string that can be
8909 # added to gdb_compile options to define the C-preprocessor macro
8910 # SYMBOL_PREFIX with a value that can be prepended to symbols
8911 # for targets which require a prefix, such as underscore.
8913 # This version (_asm) defines the prefix without double quotes
8914 # surrounding the prefix. It is used to define the macro
8915 # SYMBOL_PREFIX for assembly language files. Another version, below,
8916 # is used for symbols in inline assembler in C/C++ files.
8918 # The lack of quotes in this version (_asm) makes it possible to
8919 # define supporting macros in the .S file. (The version which
8920 # uses quotes for the prefix won't work for such files since it's
8921 # impossible to define a quote-stripping macro in C.)
8923 # It's possible to use this version (_asm) for C/C++ source files too,
8924 # but a string is usually required in such files; providing a version
8925 # (no _asm) which encloses the prefix with double quotes makes it
8926 # somewhat easier to define the supporting macros in the test case.
8928 proc gdb_target_symbol_prefix_flags_asm {} {
8929 set prefix [gdb_target_symbol_prefix]
8930 if {$prefix ne ""} {
8931 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
8937 # gdb_target_symbol_prefix_flags returns the same string as
8938 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
8939 # enclosed in double quotes if there is a prefix.
8941 # See the comment for gdb_target_symbol_prefix_flags_asm for an
8942 # extended discussion.
8944 proc gdb_target_symbol_prefix_flags {} {
8945 set prefix [gdb_target_symbol_prefix]
8946 if {$prefix ne ""} {
8947 return "additional_flags=-DSYMBOL_PREFIX=\"$prefix\""
8953 # A wrapper for 'remote_exec host' that passes or fails a test.
8954 # Returns 0 if all went well, nonzero on failure.
8955 # TEST is the name of the test, other arguments are as for remote_exec.
8957 proc run_on_host { test program args } {
8958 verbose -log "run_on_host: $program $args"
8959 # remote_exec doesn't work properly if the output is set but the
8960 # input is the empty string -- so replace an empty input with
8962 if {[llength $args] > 1 && [lindex $args 1] == ""} {
8963 set args [lreplace $args 1 1 "/dev/null"]
8965 set result [eval remote_exec host [list $program] $args]
8966 verbose "result is $result"
8967 set status [lindex $result 0]
8968 set output [lindex $result 1]
8973 verbose -log "run_on_host failed: $output"
8974 if { $output == "spawn failed" } {
8983 # Return non-zero if "board_info debug_flags" mentions Fission.
8984 # http://gcc.gnu.org/wiki/DebugFission
8985 # Fission doesn't support everything yet.
8986 # This supports working around bug 15954.
8988 proc using_fission { } {
8989 set debug_flags [board_info [target_info name] debug_flags]
8990 return [regexp -- "-gsplit-dwarf" $debug_flags]
8993 # Search LISTNAME in uplevel LEVEL caller and set variables according to the
8994 # list of valid options with prefix PREFIX described by ARGSET.
8996 # The first member of each one- or two-element list in ARGSET defines the
8997 # name of a variable that will be added to the caller's scope.
8999 # If only one element is given to describe an option, it the value is
9000 # 0 if the option is not present in (the caller's) ARGS or 1 if
9003 # If two elements are given, the second element is the default value of
9004 # the variable. This is then overwritten if the option exists in ARGS.
9005 # If EVAL, then subst is called on the value, which allows variables
9008 # Any parse_args elements in (the caller's) ARGS will be removed, leaving
9009 # any optional components.
9012 # proc myproc {foo args} {
9013 # parse_list args 1 {{bar} {baz "abc"} {qux}} "-" false
9016 # myproc ABC -bar -baz DEF peanut butter
9017 # will define the following variables in myproc:
9018 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
9019 # args will be the list {peanut butter}
9021 proc parse_list { level listname argset prefix eval } {
9022 upvar $level $listname args
9024 foreach argument $argset {
9025 if {[llength $argument] == 1} {
9026 # Normalize argument, strip leading/trailing whitespace.
9027 # Allows us to treat {foo} and { foo } the same.
9028 set argument [string trim $argument]
9030 # No default specified, so we assume that we should set
9031 # the value to 1 if the arg is present and 0 if it's not.
9032 # It is assumed that no value is given with the argument.
9033 set pattern "$prefix$argument"
9034 set result [lsearch -exact $args $pattern]
9036 if {$result != -1} {
9038 set args [lreplace $args $result $result]
9042 uplevel $level [list set $argument $value]
9043 } elseif {[llength $argument] == 2} {
9044 # There are two items in the argument. The second is a
9045 # default value to use if the item is not present.
9046 # Otherwise, the variable is set to whatever is provided
9047 # after the item in the args.
9048 set arg [lindex $argument 0]
9049 set pattern "$prefix[lindex $arg 0]"
9050 set result [lsearch -exact $args $pattern]
9052 if {$result != -1} {
9053 set value [lindex $args [expr $result+1]]
9055 set value [uplevel [expr $level + 1] [list subst $value]]
9057 set args [lreplace $args $result [expr $result+1]]
9059 set value [lindex $argument 1]
9061 set value [uplevel $level [list subst $value]]
9064 uplevel $level [list set $arg $value]
9066 error "Badly formatted argument \"$argument\" in argument set"
9071 # Search the caller's args variable and set variables according to the list of
9072 # valid options described by ARGSET.
9074 proc parse_args { argset } {
9075 parse_list 2 args $argset "-" false
9077 # The remaining args should be checked to see that they match the
9078 # number of items expected to be passed into the procedure...
9081 # Process the caller's options variable and set variables according
9082 # to the list of valid options described by OPTIONSET.
9084 proc parse_options { optionset } {
9085 parse_list 2 options $optionset "" true
9087 # Require no remaining options.
9088 upvar 1 options options
9089 if { [llength $options] != 0 } {
9090 error "Options left unparsed: $options"
9094 # Capture the output of COMMAND in a string ignoring PREFIX (a regexp);
9095 # return that string.
9097 proc capture_command_output { command prefix } {
9101 set test "capture_command_output for $command"
9103 set output_string ""
9104 gdb_test_multiple $command $test {
9105 -re "^(\[^\r\n\]+\r\n)" {
9106 if { ![string equal $output_string ""] } {
9107 set output_string [join [list $output_string $expect_out(1,string)] ""]
9109 set output_string $expect_out(1,string)
9114 -re "^$gdb_prompt $" {
9118 # Strip the command.
9119 set command_re [string_to_regexp ${command}]
9120 set output_string [regsub ^$command_re\r\n $output_string ""]
9123 if { $prefix != "" } {
9124 set output_string [regsub ^$prefix $output_string ""]
9127 # Strip a trailing newline.
9128 set output_string [regsub "\r\n$" $output_string ""]
9130 return $output_string
9133 # A convenience function that joins all the arguments together, with a
9134 # regexp that matches exactly one end of line in between each argument.
9135 # This function is ideal to write the expected output of a GDB command
9136 # that generates more than a couple of lines, as this allows us to write
9137 # each line as a separate string, which is easier to read by a human
9140 proc multi_line { args } {
9141 if { [llength $args] == 1 } {
9142 set hint "forgot {*} before list argument?"
9143 error "multi_line called with one argument ($hint)"
9145 return [join $args "\r\n"]
9148 # Similar to the above, but while multi_line is meant to be used to
9149 # match GDB output, this one is meant to be used to build strings to
9150 # send as GDB input.
9152 proc multi_line_input { args } {
9153 return [join $args "\n"]
9156 # Return how many newlines there are in the given string.
9158 proc count_newlines { string } {
9159 return [regexp -all "\n" $string]
9162 # Return the version of the DejaGnu framework.
9164 # The return value is a list containing the major, minor and patch version
9165 # numbers. If the version does not contain a minor or patch number, they will
9166 # be set to 0. For example:
9172 proc dejagnu_version { } {
9173 # The frame_version variable is defined by DejaGnu, in runtest.exp.
9174 global frame_version
9176 verbose -log "DejaGnu version: $frame_version"
9177 verbose -log "Expect version: [exp_version]"
9178 verbose -log "Tcl version: [info tclversion]"
9180 set dg_ver [split $frame_version .]
9182 while { [llength $dg_ver] < 3 } {
9189 # Define user-defined command COMMAND using the COMMAND_LIST as the
9190 # command's definition. The terminating "end" is added automatically.
9192 proc gdb_define_cmd {command command_list} {
9195 set input [multi_line_input {*}$command_list "end"]
9196 set test "define $command"
9198 gdb_test_multiple "define $command" $test {
9199 -re "End with \[^\r\n\]*\r\n *>$" {
9200 gdb_test_multiple $input $test {
9201 -re "\r\n$gdb_prompt " {
9208 # Override the 'cd' builtin with a version that ensures that the
9209 # log file keeps pointing at the same file. We need this because
9210 # unfortunately the path to the log file is recorded using an
9211 # relative path name, and, we sometimes need to close/reopen the log
9212 # after changing the current directory. See get_compiler_info.
9214 rename cd builtin_cd
9218 # Get the existing log file flags.
9219 set log_file_info [log_file -info]
9221 # Split the flags into args and file name.
9222 set log_file_flags ""
9223 set log_file_file ""
9224 foreach arg [ split "$log_file_info" " "] {
9225 if [string match "-*" $arg] {
9226 lappend log_file_flags $arg
9228 lappend log_file_file $arg
9232 # If there was an existing file, ensure it is an absolute path, and then
9234 if { $log_file_file != "" } {
9235 set log_file_file [file normalize $log_file_file]
9237 log_file $log_file_flags "$log_file_file"
9240 # Call the builtin version of cd.
9244 # Return a list of all languages supported by GDB, suitable for use in
9245 # 'set language NAME'. This doesn't include the languages auto,
9246 # local, or unknown.
9247 gdb_caching_proc gdb_supported_languages {} {
9248 # The extra space after 'complete set language ' in the command below is
9249 # critical. Only with that space will GDB complete the next level of
9250 # the command, i.e. fill in the actual language names.
9251 set output [remote_exec host $::GDB "$::INTERNAL_GDBFLAGS -batch -ex \"complete set language \""]
9253 if {[lindex $output 0] != 0} {
9254 error "failed to get list of supported languages"
9258 foreach line [split [lindex $output 1] \n] {
9259 if {[regexp "set language (\[^\r\]+)" $line full_match lang]} {
9260 # If LANG is not one of the languages that we ignore, then
9261 # add it to our list of languages.
9262 if {[lsearch -exact {auto local unknown} $lang] == -1} {
9270 # Check if debugging is enabled for gdb.
9272 proc gdb_debug_enabled { } {
9275 # If not already read, get the debug setting from environment or board setting.
9276 if {![info exists gdbdebug]} {
9278 if [info exists env(GDB_DEBUG)] {
9279 set gdbdebug $env(GDB_DEBUG)
9280 } elseif [target_info exists gdb,debug] {
9281 set gdbdebug [target_info gdb,debug]
9287 # Ensure it not empty.
9288 return [expr { $gdbdebug != "" }]
9291 # Turn on debugging if enabled, or reset if already on.
9293 proc gdb_debug_init { } {
9297 if ![gdb_debug_enabled] {
9301 # First ensure logging is off.
9302 send_gdb "set logging enabled off\n"
9304 set debugfile [standard_output_file gdb.debug]
9305 send_gdb "set logging file $debugfile\n"
9307 send_gdb "set logging debugredirect\n"
9310 foreach entry [split $gdbdebug ,] {
9311 send_gdb "set debug $entry 1\n"
9314 # Now that everything is set, enable logging.
9315 send_gdb "set logging enabled on\n"
9317 -re "Copying output to $debugfile.*Redirecting debug output to $debugfile.*$gdb_prompt $" {}
9318 timeout { warning "Couldn't set logging file" }
9322 # Check if debugging is enabled for gdbserver.
9324 proc gdbserver_debug_enabled { } {
9325 # Always disabled for GDB only setups.
9329 # Open the file for logging gdb input
9331 proc gdb_stdin_log_init { } {
9332 gdb_persistent_global in_file
9334 if {[info exists in_file]} {
9335 # Close existing file.
9336 catch "close $in_file"
9339 set logfile [standard_output_file_with_gdb_instance gdb.in]
9340 set in_file [open $logfile w]
9343 # Write to the file for logging gdb input.
9344 # TYPE can be one of the following:
9345 # "standard" : Default. Standard message written to the log
9346 # "answer" : Answer to a question (eg "Y"). Not written the log.
9347 # "optional" : Optional message. Not written to the log.
9349 proc gdb_stdin_log_write { message {type standard} } {
9352 if {![info exists in_file]} {
9356 # Check message types.
9357 switch -regexp -- $type {
9366 # Write to the log and make sure the output is there, even in case
9368 puts -nonewline $in_file "$message"
9372 # Write the command line used to invocate gdb to the cmd file.
9374 proc gdb_write_cmd_file { cmdline } {
9375 set logfile [standard_output_file_with_gdb_instance gdb.cmd]
9376 set cmd_file [open $logfile w]
9377 puts $cmd_file $cmdline
9378 catch "close $cmd_file"
9381 # Compare contents of FILE to string STR. Pass with MSG if equal, otherwise
9384 proc cmp_file_string { file str msg } {
9385 if { ![file exists $file]} {
9390 set caught_error [catch {
9391 set fp [open "$file" r]
9392 set file_contents [read $fp]
9395 if {$caught_error} {
9396 error "$error_message"
9401 if { $file_contents == $str } {
9408 # Compare FILE1 and FILE2 as binary files. Return 0 if the files are
9409 # equal, otherwise, return non-zero.
9411 proc cmp_binary_files { file1 file2 } {
9412 set fd1 [open $file1]
9413 fconfigure $fd1 -translation binary
9414 set fd2 [open $file2]
9415 fconfigure $fd2 -translation binary
9419 set blk1 [read $fd1 $blk_size]
9420 set blk2 [read $fd2 $blk_size]
9421 set diff [string compare $blk1 $blk2]
9422 if {$diff != 0 || [eof $fd1] || [eof $fd2]} {
9430 # Does the compiler support CTF debug output using '-gctf' compiler
9431 # flag? If not then we should skip these tests. We should also
9432 # skip them if libctf was explicitly disabled.
9434 gdb_caching_proc allow_ctf_tests {} {
9435 global enable_libctf
9437 if {$enable_libctf eq "no"} {
9441 set can_ctf [gdb_can_simple_compile ctfdebug {
9445 } executable "additional_flags=-gctf"]
9450 # Return 1 if compiler supports -gstatement-frontiers. Otherwise,
9453 gdb_caching_proc supports_statement_frontiers {} {
9454 return [gdb_can_simple_compile supports_statement_frontiers {
9458 } executable "additional_flags=-gstatement-frontiers"]
9461 # Return 1 if compiler supports -mmpx -fcheck-pointer-bounds. Otherwise,
9464 gdb_caching_proc supports_mpx_check_pointer_bounds {} {
9465 set flags "additional_flags=-mmpx additional_flags=-fcheck-pointer-bounds"
9466 return [gdb_can_simple_compile supports_mpx_check_pointer_bounds {
9470 } executable $flags]
9473 # Return 1 if compiler supports -fcf-protection=. Otherwise,
9476 gdb_caching_proc supports_fcf_protection {} {
9477 return [gdb_can_simple_compile supports_fcf_protection {
9481 } executable "additional_flags=-fcf-protection=full"]
9484 # Return true if symbols were read in using -readnow. Otherwise,
9488 return [expr {[lsearch -exact $::GDBFLAGS -readnow] != -1
9489 || [lsearch -exact $::GDBFLAGS --readnow] != -1}]
9492 # Return 'gdb_index' if the symbols from OBJFILE were read using a
9493 # .gdb_index index. Return 'debug_names' if the symbols were read
9494 # using a DWARF-5 style .debug_names index. Otherwise, return an
9497 proc have_index { objfile } {
9499 # This proc is mostly used with $binfile, but that gives problems with
9500 # remote host, while using $testfile would work.
9501 # Fix this by reducing $binfile to $testfile.
9502 set objfile [file tail $objfile]
9504 set index_type [get_index_type $objfile]
9506 if { $index_type eq "gdb" } {
9508 } elseif { $index_type eq "dwarf5" } {
9509 return "debug_names"
9515 # Return 1 if partial symbols are available. Otherwise, return 0.
9517 proc psymtabs_p { } {
9520 set cmd "maint info psymtab"
9521 gdb_test_multiple $cmd "" {
9522 -re "$cmd\r\n$gdb_prompt $" {
9533 # Verify that partial symtab expansion for $filename has state $readin.
9535 proc verify_psymtab_expanded { filename readin } {
9538 set cmd "maint info psymtab"
9539 set test "$cmd: $filename: $readin"
9540 set re [multi_line \
9541 " \{ psymtab \[^\r\n\]*$filename\[^\r\n\]*" \
9545 gdb_test_multiple $cmd $test {
9546 -re "$cmd\r\n$gdb_prompt $" {
9547 unsupported $gdb_test_name
9555 # Add a .gdb_index section to PROGRAM.
9556 # PROGRAM is assumed to be the output of standard_output_file.
9557 # Returns the 0 if there is a failure, otherwise 1.
9559 # STYLE controls which style of index to add, if needed. The empty
9560 # string (the default) means .gdb_index; "-dwarf-5" means .debug_names.
9562 proc add_gdb_index { program {style ""} } {
9563 global srcdir GDB env
9564 set contrib_dir "$srcdir/../contrib"
9565 set env(GDB) [append_gdb_data_directory_option $GDB]
9566 set result [catch "exec $contrib_dir/gdb-add-index.sh $style $program" output]
9567 if { $result != 0 } {
9568 verbose -log "result is $result"
9569 verbose -log "output is $output"
9576 # Use 'maint print objfiles OBJFILE' to determine what (if any) type
9577 # of index is present in OBJFILE. Return a string indicating the
9580 # 'gdb' - Contains a .gdb_index style index,
9582 # 'dwarf5' - Contain DWARF5 style index sections,
9584 # 'readnow' - A fake .gdb_index as a result of readnow being used,
9586 # 'cooked' - The cooked index created when reading non-indexed debug
9589 # 'none' - There's no index, and no debug information to create a
9590 # cooked index from.
9592 # If something goes wrong then this proc will emit a FAIL and return
9595 # TESTNAME is used as part of any pass/fail emitted from this proc.
9596 proc get_index_type { objfile { testname "" } } {
9597 if { $testname eq "" } {
9598 set testname "find index type"
9601 set index_type "unknown"
9602 gdb_test_multiple "maint print objfiles ${objfile}" $testname -lbl {
9603 -re "\r\n\\.gdb_index: version ${::decimal}(?=\r\n)" {
9604 set index_type "gdb"
9605 gdb_test_lines "" $gdb_test_name ".*"
9607 -re "\r\n\\.debug_names: exists(?=\r\n)" {
9608 set index_type "dwarf5"
9609 gdb_test_lines "" $gdb_test_name ".*"
9611 -re "\r\n(Cooked index in use:|Psymtabs)(?=\r\n)" {
9612 set index_type "cooked"
9613 gdb_test_lines "" $gdb_test_name ".*"
9615 -re ".gdb_index: faked for \"readnow\"" {
9616 set index_type "readnow"
9617 gdb_test_lines "" $gdb_test_name ".*"
9620 set index_type "none"
9624 gdb_assert { $index_type ne "unknown" } \
9625 "$testname, check type is valid"
9627 if { $index_type eq "unknown" } {
9634 # Add a .gdb_index section to PROGRAM, unless it alread has an index
9635 # (.gdb_index/.debug_names). Gdb doesn't support building an index from a
9636 # program already using one. Return 1 if a .gdb_index was added, return 0
9637 # if it already contained an index, and -1 if an error occurred.
9639 # STYLE controls which style of index to add, if needed. The empty
9640 # string (the default) means .gdb_index; "-dwarf-5" means .debug_names.
9642 proc ensure_gdb_index { binfile {style ""} } {
9643 set testfile [file tail $binfile]
9645 set test "check if index present"
9646 set index_type [get_index_type $testfile $test]
9648 if { $index_type eq "gdb" || $index_type eq "dwarf5" } {
9652 if { $index_type eq "readnow" } {
9656 if { [add_gdb_index $binfile $style] == "1" } {
9663 # Return 1 if executable contains .debug_types section. Otherwise, return 0.
9665 proc debug_types { } {
9668 set cmd "maint info sections"
9669 gdb_test_multiple $cmd "" {
9670 -re -wrap "at $hex: .debug_types.*" {
9681 # Return the addresses in the line table for FILE for which is_stmt is true.
9683 proc is_stmt_addresses { file } {
9689 gdb_test_multiple "maint info line-table $file" "" {
9690 -re "\r\n$decimal\[ \t\]+$decimal\[ \t\]+($hex)\[ \t\]+$hex\[ \t\]+Y\[^\r\n\]*" {
9691 lappend is_stmt $expect_out(1,string)
9701 # Return 1 if hex number VAL is an element of HEXLIST.
9703 proc hex_in_list { val hexlist } {
9704 # Normalize val by removing 0x prefix, and leading zeros.
9705 set val [regsub ^0x $val ""]
9706 set val [regsub ^0+ $val "0"]
9709 set index [lsearch -regexp $hexlist $re]
9710 return [expr $index != -1]
9713 # As info args, but also add the default values.
9715 proc info_args_with_defaults { name } {
9718 foreach arg [info args $name] {
9719 if { [info default $name $arg default_value] } {
9720 lappend args [list $arg $default_value]
9729 # Override proc NAME to proc OVERRIDE for the duration of the execution of
9732 proc with_override { name override body } {
9733 # Implementation note: It's possible to implement the override using
9734 # rename, like this:
9735 # rename $name save_$name
9736 # rename $override $name
9737 # set code [catch {uplevel 1 $body} result]
9738 # rename $name $override
9739 # rename save_$name $name
9740 # but there are two issues here:
9741 # - the save_$name might clash with an existing proc
9742 # - the override is no longer available under its original name during
9744 # So, we use this more elaborate but cleaner mechanism.
9746 # Save the old proc, if it exists.
9747 if { [info procs $name] != "" } {
9748 set old_args [info_args_with_defaults $name]
9749 set old_body [info body $name]
9755 # Install the override.
9756 set new_args [info_args_with_defaults $override]
9757 set new_body [info body $override]
9758 eval proc $name {$new_args} {$new_body}
9761 set code [catch {uplevel 1 $body} result]
9763 # Restore old proc if it existed on entry, else delete it.
9765 eval proc $name {$old_args} {$old_body}
9770 # Return as appropriate.
9772 global errorInfo errorCode
9773 return -code error -errorinfo $errorInfo -errorcode $errorCode $result
9774 } elseif { $code > 1 } {
9775 return -code $code $result
9781 # Run BODY after setting the TERM environment variable to 'ansi', and
9782 # unsetting the NO_COLOR environment variable.
9783 proc with_ansi_styling_terminal { body } {
9784 save_vars { ::env(TERM) ::env(NO_COLOR) } {
9785 # Set environment variables to allow styling.
9787 unset -nocomplain ::env(NO_COLOR)
9789 set code [catch {uplevel 1 $body} result]
9793 global errorInfo errorCode
9794 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
9796 return -code $code $result
9800 # Setup tuiterm.exp environment. To be used in test-cases instead of
9801 # "load_lib tuiterm.exp". Calls initialization function and schedules
9802 # finalization function.
9803 proc tuiterm_env { } {
9804 load_lib tuiterm.exp
9807 # Dejagnu has a version of note, but usage is not allowed outside of dejagnu.
9808 # Define a local version.
9809 proc gdb_note { message } {
9810 verbose -- "NOTE: $message" 0
9813 # Return 1 if compiler supports -fuse-ld=gold, otherwise return 0.
9814 gdb_caching_proc have_fuse_ld_gold {} {
9815 set me "have_fuse_ld_gold"
9816 set flags "additional_flags=-fuse-ld=gold"
9817 set src { int main() { return 0; } }
9818 return [gdb_simple_compile $me $src executable $flags]
9821 # Return 1 if compiler supports fvar-tracking, otherwise return 0.
9822 gdb_caching_proc have_fvar_tracking {} {
9823 set me "have_fvar_tracking"
9824 set flags "additional_flags=-fvar-tracking"
9825 set src { int main() { return 0; } }
9826 return [gdb_simple_compile $me $src executable $flags]
9829 # Return 1 if linker supports -Ttext-segment, otherwise return 0.
9830 gdb_caching_proc linker_supports_Ttext_segment_flag {} {
9831 set me "linker_supports_Ttext_segment_flag"
9832 set flags ldflags="-Wl,-Ttext-segment=0x7000000"
9833 set src { int main() { return 0; } }
9834 return [gdb_simple_compile $me $src executable $flags]
9837 # Return 1 if linker supports -Ttext, otherwise return 0.
9838 gdb_caching_proc linker_supports_Ttext_flag {} {
9839 set me "linker_supports_Ttext_flag"
9840 set flags ldflags="-Wl,-Ttext=0x7000000"
9841 set src { int main() { return 0; } }
9842 return [gdb_simple_compile $me $src executable $flags]
9845 # Return 1 if linker supports --image-base, otherwise 0.
9846 gdb_caching_proc linker_supports_image_base_flag {} {
9847 set me "linker_supports_image_base_flag"
9848 set flags ldflags="-Wl,--image-base=0x7000000"
9849 set src { int main() { return 0; } }
9850 return [gdb_simple_compile $me $src executable $flags]
9854 # Return 1 if compiler supports scalar_storage_order attribute, otherwise
9856 gdb_caching_proc supports_scalar_storage_order_attribute {} {
9857 set me "supports_scalar_storage_order_attribute"
9862 } __attribute__((scalar_storage_order("little-endian")));
9865 } __attribute__((scalar_storage_order("big-endian")));
9869 sle.v = sbe.v = 0x11223344;
9870 int same = memcmp (&sle, &sbe, sizeof (int)) == 0;
9875 if { ![gdb_simple_compile $me $src executable ""] } {
9879 set target_obj [gdb_remote_download target $obj]
9880 set result [remote_exec target $target_obj]
9881 set status [lindex $result 0]
9882 set output [lindex $result 1]
9883 if { $output != "" } {
9890 # Return 1 if compiler supports __GNUC__, otherwise return 0.
9891 gdb_caching_proc supports_gnuc {} {
9892 set me "supports_gnuc"
9898 return [gdb_simple_compile $me $src object ""]
9901 # Return 1 if target supports mpx, otherwise return 0.
9902 gdb_caching_proc have_mpx {} {
9906 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
9907 verbose "$me: target does not support mpx, returning 0" 2
9911 # Compile a test program.
9913 #include "nat/x86-cpuid.h"
9916 unsigned int eax, ebx, ecx, edx;
9918 if (!__get_cpuid (1, &eax, &ebx, &ecx, &edx))
9921 if ((ecx & bit_OSXSAVE) == bit_OSXSAVE)
9923 if (__get_cpuid_max (0, (void *)0) < 7)
9926 __cpuid_count (7, 0, eax, ebx, ecx, edx);
9928 if ((ebx & bit_MPX) == bit_MPX)
9935 set compile_flags "incdir=${srcdir}/.."
9936 if {![gdb_simple_compile $me $src executable $compile_flags]} {
9940 set target_obj [gdb_remote_download target $obj]
9941 set result [remote_exec target $target_obj]
9942 set status [lindex $result 0]
9943 set output [lindex $result 1]
9944 if { $output != "" } {
9948 remote_file build delete $obj
9950 if { $status == 0 } {
9951 verbose "$me: returning $status" 2
9955 # Compile program with -mmpx -fcheck-pointer-bounds, try to trigger
9956 # 'No MPX support', in other words, see if kernel supports mpx.
9957 set src { int main (void) { return 0; } }
9959 append comp_flags " additional_flags=-mmpx"
9960 append comp_flags " additional_flags=-fcheck-pointer-bounds"
9961 if {![gdb_simple_compile $me-2 $src executable $comp_flags]} {
9965 set target_obj [gdb_remote_download target $obj]
9966 set result [remote_exec target $target_obj]
9967 set status [lindex $result 0]
9968 set output [lindex $result 1]
9969 set status [expr ($status == 0) \
9970 && ![regexp "^No MPX support\r?\n" $output]]
9972 remote_file build delete $obj
9974 verbose "$me: returning $status" 2
9978 # Return 1 if target supports avx, otherwise return 0.
9979 gdb_caching_proc have_avx {} {
9983 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
9984 verbose "$me: target does not support avx, returning 0" 2
9988 # Compile a test program.
9990 #include "nat/x86-cpuid.h"
9993 unsigned int eax, ebx, ecx, edx;
9995 if (!x86_cpuid (1, &eax, &ebx, &ecx, &edx))
9998 if ((ecx & (bit_AVX | bit_OSXSAVE)) == (bit_AVX | bit_OSXSAVE))
10004 set compile_flags "incdir=${srcdir}/.."
10005 if {![gdb_simple_compile $me $src executable $compile_flags]} {
10009 set target_obj [gdb_remote_download target $obj]
10010 set result [remote_exec target $target_obj]
10011 set status [lindex $result 0]
10012 set output [lindex $result 1]
10013 if { $output != "" } {
10017 remote_file build delete $obj
10019 verbose "$me: returning $status" 2
10026 # ARG can either be a name, or of the form !NAME.
10028 # Each name is a proc to evaluate in the caller's context. It can return a
10029 # boolean or a two element list with a boolean and a reason string.
10030 # A "!" means to invert the result. If this is true, all is well. If it is
10031 # false, an "unsupported" is emitted and this proc causes the caller to return.
10033 # The reason string is used to provide some context about a require failure,
10034 # and is included in the "unsupported" message.
10036 proc require { args } {
10037 foreach arg $args {
10038 if {[string index $arg 0] == "!"} {
10040 set fn [string range $arg 1 end]
10046 set result [uplevel 1 $fn]
10047 set len [llength $result]
10049 set actual_val [lindex $result 0]
10050 set msg [lindex $result 1]
10051 } elseif { $len == 1 } {
10052 set actual_val $result
10055 error "proc $fn returned a list of unexpected length $len"
10058 if {$required_val != !!$actual_val} {
10059 if { [string length $msg] > 0 } {
10060 unsupported "require failed: $arg ($msg)"
10062 unsupported "require failed: $arg"
10065 return -code return 0
10070 # Wait up to ::TIMEOUT seconds for file PATH to exist on the target system.
10071 # Return 1 if it does exist, 0 otherwise.
10073 proc target_file_exists_with_timeout { path } {
10074 for {set i 0} {$i < $::timeout} {incr i} {
10075 if { [remote_file target exists $path] } {
10085 gdb_caching_proc has_hw_wp_support {} {
10086 # Power 9, proc rev 2.2 does not support HW watchpoints due to HW bug.
10087 # Need to use a runtime test to determine if the Power processor has
10088 # support for HW watchpoints.
10089 global srcdir subdir gdb_prompt inferior_exited_re
10091 set me "has_hw_wp_support"
10093 global gdb_spawn_id
10094 if { [info exists gdb_spawn_id] } {
10095 error "$me called with running gdb instance"
10098 set compile_flags {debug nowarnings quiet}
10100 # Compile a test program to test if HW watchpoints are supported
10103 volatile int local;
10111 if {![gdb_simple_compile $me $src executable $compile_flags]} {
10116 gdb_reinitialize_dir $srcdir/$subdir
10121 remote_file build delete $obj
10123 set has_hw_wp_support 0
10124 return $has_hw_wp_support
10127 # The goal is to determine if HW watchpoints are available in general.
10128 # Use "watch" and then check if gdb responds with hardware watch point.
10129 set test "watch local"
10131 gdb_test_multiple $test "Check for HW watchpoint support" {
10132 -re ".*Hardware watchpoint.*" {
10133 # HW watchpoint supported by platform
10134 verbose -log "\n$me: Hardware watchpoint detected"
10135 set has_hw_wp_support 1
10137 -re ".*$gdb_prompt $" {
10138 set has_hw_wp_support 0
10139 verbose -log "\n$me: Default, hardware watchpoint not deteced"
10144 remote_file build delete $obj
10146 verbose "$me: returning $has_hw_wp_support" 2
10147 return $has_hw_wp_support
10150 # Return a list of all the accepted values of the set command
10151 # "SET_CMD SET_ARG".
10152 # For example get_set_option_choices "set architecture" "i386".
10154 proc get_set_option_choices { set_cmd {set_arg ""} } {
10157 if { $set_arg == "" } {
10158 # Add trailing space to signal that we need completion of the choices,
10159 # not of set_cmd itself.
10160 set cmd "complete $set_cmd "
10162 set cmd "complete $set_cmd $set_arg"
10165 # Set test name without trailing space.
10166 set test [string trim $cmd]
10168 with_set max-completions unlimited {
10169 gdb_test_multiple $cmd $test {
10170 -re "^[string_to_regexp $cmd]\r\n" {
10174 -re "^$set_cmd (\[^\r\n\]+)\r\n" {
10175 lappend values $expect_out(1,string)
10179 -re "^$::gdb_prompt $" {
10180 pass $gdb_test_name
10188 # Return the compiler that can generate 32-bit ARM executables. Used
10189 # when testing biarch support on Aarch64. If ARM_CC_FOR_TARGET is
10190 # set, use that. If not, try a few common compiler names, making sure
10191 # that the executable they produce can run.
10193 gdb_caching_proc arm_cc_for_target {} {
10194 if {[info exists ::ARM_CC_FOR_TARGET]} {
10195 # If the user specified the compiler explicitly, then don't
10196 # check whether the resulting binary runs outside GDB. Assume
10197 # that it does, and if it turns out it doesn't, then the user
10198 # should get loud FAILs, instead of UNSUPPORTED.
10199 return $::ARM_CC_FOR_TARGET
10202 # Fallback to a few common compiler names. Also confirm the
10203 # produced binary actually runs on the system before declaring
10204 # we've found the right compiler.
10206 if [istarget "*-linux*-*"] {
10208 arm-linux-gnueabi-gcc
10209 arm-none-linux-gnueabi-gcc
10210 arm-linux-gnueabihf-gcc
10216 foreach compiler $compilers {
10217 if {![is_remote host] && [which $compiler] == 0} {
10218 # Avoid "default_target_compile: Can't find
10219 # $compiler." warning issued from gdb_compile.
10223 set src { int main() { return 0; } }
10224 if {[gdb_simple_compile aarch64-32bit \
10226 executable [list compiler=$compiler]]} {
10228 set target_obj [gdb_remote_download target $obj]
10229 set result [remote_exec target $target_obj]
10230 set status [lindex $result 0]
10231 set output [lindex $result 1]
10235 if { $output == "" && $status == 0} {
10244 # Step until the pattern REGEXP is found. Step at most
10245 # MAX_STEPS times, but stop stepping once REGEXP is found.
10246 # CURRENT matches current location
10247 # If REGEXP is found then a single pass is emitted, otherwise, after
10248 # MAX_STEPS steps, a single fail is emitted.
10250 # TEST_NAME is the name used in the pass/fail calls.
10252 proc gdb_step_until { regexp {test_name "stepping until regexp"} \
10253 {current "\}"} { max_steps 10 } } {
10254 repeat_cmd_until "step" $current $regexp $test_name "10"
10257 # Do repeated stepping COMMANDs in order to reach TARGET from CURRENT
10259 # COMMAND is a stepping command
10260 # CURRENT is a string matching the current location
10261 # TARGET is a string matching the target location
10262 # TEST_NAME is the test name
10263 # MAX_STEPS is number of steps attempted before fail is emitted
10265 # The function issues repeated COMMANDs as long as the location matches
10266 # CURRENT up to a maximum of MAX_STEPS.
10268 # TEST_NAME passes if the resulting location matches TARGET and fails
10271 proc repeat_cmd_until { command current target \
10272 {test_name "stepping until regexp"} \
10273 {max_steps 100} } {
10277 gdb_test_multiple "$command" "$test_name" {
10278 -re "$target.*$gdb_prompt $" {
10281 -re "$current.*$gdb_prompt $" {
10283 if { $count < $max_steps } {
10284 send_gdb "$command\n"
10293 # Return false if the current target is not operating in non-stop
10294 # mode, otherwise, return true.
10296 # The inferior will need to have started running in order to get the
10299 proc is_target_non_stop { {testname ""} } {
10300 # For historical reasons we assume non-stop mode is on. If the
10301 # maintenance command fails for any reason then we're going to
10303 set is_non_stop true
10304 gdb_test_multiple "maint show target-non-stop" $testname {
10305 -wrap -re "(is|currently) on.*" {
10306 set is_non_stop true
10308 -wrap -re "(is|currently) off.*" {
10309 set is_non_stop false
10312 return $is_non_stop
10315 # Return the number of worker threads that GDB is currently using.
10317 proc gdb_get_worker_threads { {testname ""} } {
10318 set worker_threads "UNKNOWN"
10319 gdb_test_multiple "maintenance show worker-threads" $testname {
10320 -wrap -re "^The number of worker threads GDB can use is the default \\(currently ($::decimal)\\)\\." {
10321 set worker_threads $expect_out(1,string)
10323 -wrap -re "^The number of worker threads GDB can use is ($::decimal)\\." {
10324 set worker_threads $expect_out(1,string)
10327 return $worker_threads
10330 # Check if the compiler emits epilogue information associated
10331 # with the closing brace or with the last statement line.
10333 # This proc restarts GDB
10335 # Returns True if it is associated with the closing brace,
10336 # False if it is the last statement
10337 gdb_caching_proc have_epilogue_line_info {} {
10346 if {![gdb_simple_compile "simple_program" $main]} {
10352 gdb_test_multiple "info line 6" "epilogue test" {
10353 -re -wrap ".*starts at address.*and ends at.*" {
10362 # Decompress file BZ2, and return it.
10364 proc decompress_bz2 { bz2 } {
10365 set copy [standard_output_file [file tail $bz2]]
10366 set copy [remote_download build $bz2 $copy]
10367 if { $copy == "" } {
10371 set res [remote_exec build "bzip2" "-df $copy"]
10372 if { [lindex $res 0] == -1 } {
10376 set copy [regsub {.bz2$} $copy ""]
10377 if { ![remote_file build exists $copy] } {
10384 # Return 1 if the output of "ldd FILE" contains regexp DEP, 0 if it doesn't,
10385 # and -1 if there was a problem running the command.
10387 proc has_dependency { file dep } {
10388 set ldd [gdb_find_ldd]
10389 set command "$ldd $file"
10390 set result [remote_exec host $command]
10391 set status [lindex $result 0]
10392 set output [lindex $result 1]
10393 verbose -log "status of $command is $status"
10394 verbose -log "output of $command is $output"
10395 if { $status != 0 || $output == "" } {
10398 return [regexp $dep $output]
10401 # Detect linux kernel version and return as list of 3 numbers: major, minor,
10402 # and patchlevel. On failure, return an empty list.
10404 gdb_caching_proc linux_kernel_version {} {
10405 if { ![istarget *-*-linux*] } {
10409 set res [remote_exec target "uname -r"]
10410 set status [lindex $res 0]
10411 set output [lindex $res 1]
10412 if { $status != 0 } {
10416 set re ^($::decimal)\\.($::decimal)\\.($::decimal)
10417 if { [regexp $re $output dummy v1 v2 v3] != 1 } {
10421 return [list $v1 $v2 $v3]
10424 # Return 1 if syscall NAME is supported.
10426 proc have_syscall { name } {
10429 "#include <sys/syscall.h>" \
10430 "int var = SYS_$name;"]
10431 set src [join $src "\n"]
10432 return [gdb_can_simple_compile have_syscall_$name $src object]
10435 # Return 1 if compile flag FLAG is supported.
10437 gdb_caching_proc have_compile_flag { flag } {
10438 set src { void foo () {} }
10439 return [gdb_can_simple_compile have_compile_flag_$flag $src object \
10440 additional_flags=$flag]
10443 # Return 1 if we can create an executable using compile and link flag FLAG.
10445 gdb_caching_proc have_compile_and_link_flag { flag } {
10446 set src { int main () { return 0; } }
10447 return [gdb_can_simple_compile have_compile_and_link_flag_$flag $src executable \
10448 additional_flags=$flag]
10451 # Return 1 if this GDB is configured with a "native" target.
10453 gdb_caching_proc have_native_target {} {
10454 gdb_test_multiple "help target native" "" {
10455 -re -wrap "Undefined target command.*" {
10458 -re -wrap "Native process.*" {
10465 # Handle include file $srcdir/$subdir/FILE.
10467 proc include_file { file } {
10468 set file [file join $::srcdir $::subdir $file]
10469 if { [is_remote host] } {
10470 set res [remote_download host $file]
10478 # Handle include file FILE, and if necessary update compiler flags variable
10481 proc lappend_include_file { flags file } {
10482 upvar $flags up_flags
10483 if { [is_remote host] } {
10484 gdb_remote_download host $file
10486 set dir [file dirname $file]
10487 if { $dir != [file join $::srcdir $::subdir] } {
10488 lappend up_flags "additional_flags=-I$dir"
10493 # Return a list of supported host locales.
10495 gdb_caching_proc host_locales { } {
10496 set result [remote_exec host "locale -a"]
10497 set status [lindex $result 0]
10498 set output [lindex $result 1]
10500 if { $status != 0 } {
10505 set output [string trim $output]
10506 set l [split $output \n]
10509 set l [lmap v $l { string trim $v }]
10511 # Normalize items to lower-case.
10512 set l [lmap v $l { string tolower $v }]
10513 # Normalize items to without dash.
10514 set l [lmap v $l { string map { "-" "" } $v }]
10519 # Return 1 if host locale LOCALE is supported.
10521 proc have_host_locale { locale } {
10522 # Normalize to lower-case.
10523 set locale [string tolower $locale]
10524 # Normalize to without dash.
10525 set locale [string map { "-" "" } $locale]
10527 set idx [lsearch [host_locales] $locale]
10528 return [expr $idx != -1]
10531 # Return 1 if we can use '#include <$file>' in source file.
10533 gdb_caching_proc have_system_header { file } {
10534 set src "#include <$file>"
10535 set name [string map { "/" "_sep_" } $file]
10536 return [gdb_can_simple_compile have_system_header_$name $src object]
10539 # Return 1 if the test is being run as root, 0 otherwise.
10541 gdb_caching_proc root_user {} {
10542 # ID outputs to stdout, we have to use exec to capture it here.
10543 set res [remote_exec target id]
10544 set ret_val [lindex $res 0]
10545 set output [lindex $res 1]
10547 # If ret_val is not 0, we couldn't run `id` on the target for some
10548 # reason. Return that we are not root, so problems are easier to
10550 if { $ret_val != 0 } {
10554 regexp -all ".*uid=(\[0-9\]+).*" $output dummy uid
10556 return [expr $uid == 0]
10559 # Always load compatibility stuff.
10560 load_lib future.exp