* cli/cli-decode.c (add_cmd): Add comment.
[deliverable/binutils-gdb.git] / gdb / testsuite / lib / gdb.exp
CommitLineData
6aba47ca 1# Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
7b6bb8da
JB
2# 2003, 2004, 2005, 2007, 2008, 2009, 2010, 2011
3# Free Software Foundation, Inc.
c906108c
SS
4
5# This program is free software; you can redistribute it and/or modify
6# it under the terms of the GNU General Public License as published by
e22f8b7c 7# the Free Software Foundation; either version 3 of the License, or
c906108c 8# (at your option) any later version.
e22f8b7c 9#
c906108c
SS
10# This program is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13# GNU General Public License for more details.
e22f8b7c 14#
c906108c 15# You should have received a copy of the GNU General Public License
e22f8b7c 16# along with this program. If not, see <http://www.gnu.org/licenses/>.
c906108c 17
c906108c
SS
18# This file was written by Fred Fish. (fnf@cygnus.com)
19
20# Generic gdb subroutines that should work for any target. If these
21# need to be modified for any target, it can be done with a variable
22# or by passing arguments.
23
97c3f1f3
JK
24if {$tool == ""} {
25 # Tests would fail, logs on get_compiler_info() would be missing.
26 send_error "`site.exp' not found, run `make site.exp'!\n"
27 exit 2
28}
29
c906108c
SS
30load_lib libgloss.exp
31
32global GDB
c906108c
SS
33
34if [info exists TOOL_EXECUTABLE] {
35 set GDB $TOOL_EXECUTABLE;
36}
37if ![info exists GDB] {
38 if ![is_remote host] {
39 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
40 } else {
41 set GDB [transform gdb];
42 }
43}
44verbose "using GDB = $GDB" 2
45
6b8ce727
DE
46# GDBFLAGS is available for the user to set on the command line.
47# E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
48# Testcases may use it to add additional flags, but they must:
49# - append new flags, not overwrite
50# - restore the original value when done
c906108c
SS
51global GDBFLAGS
52if ![info exists GDBFLAGS] {
6b8ce727 53 set GDBFLAGS ""
c906108c
SS
54}
55verbose "using GDBFLAGS = $GDBFLAGS" 2
56
6b8ce727 57# INTERNAL_GDBFLAGS contains flags that the testsuite requires.
1be00882
DE
58global INTERNAL_GDBFLAGS
59if ![info exists INTERNAL_GDBFLAGS] {
aae1c79a 60 set INTERNAL_GDBFLAGS "-nw -nx -data-directory [pwd]/../data-directory"
1be00882 61}
6b8ce727 62
9e0b60a8
JM
63# The variable gdb_prompt is a regexp which matches the gdb prompt.
64# Set it if it is not already set.
c906108c 65global gdb_prompt
9e0b60a8 66if ![info exists gdb_prompt] then {
c906108c
SS
67 set gdb_prompt "\[(\]gdb\[)\]"
68}
69
6006a3a1
BR
70# The variable fullname_syntax_POSIX is a regexp which matches a POSIX
71# absolute path ie. /foo/
d0b76dc6 72set fullname_syntax_POSIX {/[^\n]*/}
6006a3a1
BR
73# The variable fullname_syntax_UNC is a regexp which matches a Windows
74# UNC path ie. \\D\foo\
d0b76dc6 75set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
6006a3a1
BR
76# The variable fullname_syntax_DOS_CASE is a regexp which matches a
77# particular DOS case that GDB most likely will output
78# ie. \foo\, but don't match \\.*\
d0b76dc6 79set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
6006a3a1
BR
80# The variable fullname_syntax_DOS is a regexp which matches a DOS path
81# ie. a:\foo\ && a:foo\
d0b76dc6 82set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
6006a3a1
BR
83# The variable fullname_syntax is a regexp which matches what GDB considers
84# an absolute path. It is currently debatable if the Windows style paths
85# d:foo and \abc should be considered valid as an absolute path.
86# Also, the purpse of this regexp is not to recognize a well formed
87# absolute path, but to say with certainty that a path is absolute.
88set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
89
93076499
ND
90# Needed for some tests under Cygwin.
91global EXEEXT
92global env
93
94if ![info exists env(EXEEXT)] {
95 set EXEEXT ""
96} else {
97 set EXEEXT $env(EXEEXT)
98}
99
bb2bed55
NR
100set octal "\[0-7\]+"
101
eceb0c5f 102set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
fda326dd 103
085dd6e6
JM
104### Only procedures should come after this point.
105
c906108c
SS
106#
107# gdb_version -- extract and print the version number of GDB
108#
109proc default_gdb_version {} {
110 global GDB
6b8ce727 111 global INTERNAL_GDBFLAGS GDBFLAGS
c906108c 112 global gdb_prompt
fa335448 113 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
c906108c
SS
114 set tmp [lindex $output 1];
115 set version ""
116 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
117 if ![is_remote host] {
6b8ce727 118 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
c906108c 119 } else {
6b8ce727 120 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
c906108c
SS
121 }
122}
123
124proc gdb_version { } {
125 return [default_gdb_version];
126}
127
128#
129# gdb_unload -- unload a file if one is loaded
130#
131
132proc gdb_unload {} {
133 global verbose
134 global GDB
135 global gdb_prompt
136 send_gdb "file\n"
137 gdb_expect 60 {
138 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
139 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
959e7469
PM
140 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
141 send_gdb "y\n"
c906108c
SS
142 exp_continue
143 }
144 -re "Discard symbol table from .*y or n.*$" {
145 send_gdb "y\n"
146 exp_continue
147 }
148 -re "$gdb_prompt $" {}
149 timeout {
150 perror "couldn't unload file in $GDB (timed out)."
151 return -1
152 }
153 }
154}
155
156# Many of the tests depend on setting breakpoints at various places and
157# running until that breakpoint is reached. At times, we want to start
158# with a clean-slate with respect to breakpoints, so this utility proc
159# lets us do this without duplicating this code everywhere.
160#
161
162proc delete_breakpoints {} {
163 global gdb_prompt
164
a0b3c4fd
JM
165 # we need a larger timeout value here or this thing just confuses
166 # itself. May need a better implementation if possible. - guo
167 #
c906108c 168 send_gdb "delete breakpoints\n"
a0b3c4fd 169 gdb_expect 100 {
c906108c
SS
170 -re "Delete all breakpoints.*y or n.*$" {
171 send_gdb "y\n";
172 exp_continue
173 }
174 -re "$gdb_prompt $" { # This happens if there were no breakpoints
175 }
176 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
177 }
178 send_gdb "info breakpoints\n"
a0b3c4fd 179 gdb_expect 100 {
c906108c
SS
180 -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
181 -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
182 -re "Delete all breakpoints.*or n.*$" {
183 send_gdb "y\n";
184 exp_continue
185 }
186 timeout { perror "info breakpoints (timeout)" ; return }
187 }
188}
189
190
191#
192# Generic run command.
193#
194# The second pattern below matches up to the first newline *only*.
195# Using ``.*$'' could swallow up output that we attempt to match
196# elsewhere.
197#
198proc gdb_run_cmd {args} {
199 global gdb_prompt
200
201 if [target_info exists gdb_init_command] {
202 send_gdb "[target_info gdb_init_command]\n";
203 gdb_expect 30 {
204 -re "$gdb_prompt $" { }
205 default {
206 perror "gdb_init_command for target failed";
207 return;
208 }
209 }
210 }
211
212 if [target_info exists use_gdb_stub] {
213 if [target_info exists gdb,do_reload_on_run] {
b741e217 214 if { [gdb_reload] != 0 } {
917317f4
JM
215 return;
216 }
c906108c
SS
217 send_gdb "continue\n";
218 gdb_expect 60 {
219 -re "Continu\[^\r\n\]*\[\r\n\]" {}
220 default {}
221 }
222 return;
223 }
224
225 if [target_info exists gdb,start_symbol] {
226 set start [target_info gdb,start_symbol];
227 } else {
228 set start "start";
229 }
230 send_gdb "jump *$start\n"
917317f4
JM
231 set start_attempt 1;
232 while { $start_attempt } {
233 # Cap (re)start attempts at three to ensure that this loop
234 # always eventually fails. Don't worry about trying to be
235 # clever and not send a command when it has failed.
236 if [expr $start_attempt > 3] {
237 perror "Jump to start() failed (retry count exceeded)";
c906108c
SS
238 return;
239 }
917317f4
JM
240 set start_attempt [expr $start_attempt + 1];
241 gdb_expect 30 {
242 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
243 set start_attempt 0;
244 }
245 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
246 perror "Can't find start symbol to run in gdb_run";
247 return;
248 }
249 -re "No symbol \"start\" in current.*$gdb_prompt $" {
250 send_gdb "jump *_start\n";
251 }
252 -re "No symbol.*context.*$gdb_prompt $" {
253 set start_attempt 0;
254 }
255 -re "Line.* Jump anyway.*y or n. $" {
256 send_gdb "y\n"
257 }
258 -re "The program is not being run.*$gdb_prompt $" {
b741e217 259 if { [gdb_reload] != 0 } {
917317f4
JM
260 return;
261 }
262 send_gdb "jump *$start\n";
263 }
264 timeout {
265 perror "Jump to start() failed (timeout)";
266 return
267 }
c906108c 268 }
c906108c
SS
269 }
270 if [target_info exists gdb_stub] {
271 gdb_expect 60 {
272 -re "$gdb_prompt $" {
273 send_gdb "continue\n"
274 }
275 }
276 }
277 return
278 }
83f66e8f
DJ
279
280 if [target_info exists gdb,do_reload_on_run] {
b741e217 281 if { [gdb_reload] != 0 } {
83f66e8f
DJ
282 return;
283 }
284 }
c906108c
SS
285 send_gdb "run $args\n"
286# This doesn't work quite right yet.
5aa7ddc2
PM
287# Use -notransfer here so that test cases (like chng-sym.exp)
288# may test for additional start-up messages.
289 gdb_expect 60 {
c906108c
SS
290 -re "The program .* has been started already.*y or n. $" {
291 send_gdb "y\n"
292 exp_continue
293 }
bbb88ebf 294 -notransfer -re "Starting program: \[^\r\n\]*" {}
8e46892c
JK
295 -notransfer -re "$gdb_prompt $" {
296 # There is no more input expected.
297 }
c906108c
SS
298 }
299}
300
b741e217
DJ
301# Generic start command. Return 0 if we could start the program, -1
302# if we could not.
303
304proc gdb_start_cmd {args} {
305 global gdb_prompt
306
307 if [target_info exists gdb_init_command] {
308 send_gdb "[target_info gdb_init_command]\n";
309 gdb_expect 30 {
310 -re "$gdb_prompt $" { }
311 default {
312 perror "gdb_init_command for target failed";
313 return;
314 }
315 }
316 }
317
318 if [target_info exists use_gdb_stub] {
319 return -1
320 }
321
322 send_gdb "start $args\n"
2de75e71
JB
323 # Use -notransfer here so that test cases (like chng-sym.exp)
324 # may test for additional start-up messages.
b741e217
DJ
325 gdb_expect 60 {
326 -re "The program .* has been started already.*y or n. $" {
327 send_gdb "y\n"
328 exp_continue
329 }
b741e217
DJ
330 -notransfer -re "Starting program: \[^\r\n\]*" {
331 return 0
332 }
333 }
334 return -1
335}
336
78a1a894 337# Set a breakpoint at FUNCTION. If there is an additional argument it is
55cd6f92
DJ
338# a list of options; the supported options are allow-pending, temporary,
339# and no-message.
78a1a894
DJ
340
341proc gdb_breakpoint { function args } {
c906108c
SS
342 global gdb_prompt
343 global decimal
344
78a1a894
DJ
345 set pending_response n
346 if {[lsearch -exact [lindex $args 0] allow-pending] != -1} {
347 set pending_response y
348 }
349
e48883f7 350 set break_command "break"
18ac113b 351 set break_message "Breakpoint"
e48883f7
DJ
352 if {[lsearch -exact [lindex $args 0] temporary] != -1} {
353 set break_command "tbreak"
18ac113b 354 set break_message "Temporary breakpoint"
e48883f7
DJ
355 }
356
55cd6f92
DJ
357 set no_message 0
358 if {[lsearch -exact [lindex $args 0] no-message] != -1} {
359 set no_message 1
360 }
361
e48883f7 362 send_gdb "$break_command $function\n"
c906108c
SS
363 # The first two regexps are what we get with -g, the third is without -g.
364 gdb_expect 30 {
18ac113b
AR
365 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
366 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
367 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
368 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
78a1a894 369 if {$pending_response == "n"} {
55cd6f92
DJ
370 if { $no_message == 0 } {
371 fail "setting breakpoint at $function"
372 }
78a1a894
DJ
373 return 0
374 }
375 }
9f27c604 376 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
78a1a894 377 send_gdb "$pending_response\n"
14b1a056 378 exp_continue
18fe2033 379 }
28781456
JK
380 -re "A problem internal to GDB has been detected" {
381 fail "setting breakpoint at $function in runto (GDB internal error)"
382 gdb_internal_error_resync
383 return 0
384 }
55cd6f92
DJ
385 -re "$gdb_prompt $" {
386 if { $no_message == 0 } {
387 fail "setting breakpoint at $function"
388 }
389 return 0
390 }
391 timeout {
392 if { $no_message == 0 } {
393 fail "setting breakpoint at $function (timeout)"
394 }
395 return 0
396 }
c906108c
SS
397 }
398 return 1;
399}
400
401# Set breakpoint at function and run gdb until it breaks there.
402# Since this is the only breakpoint that will be set, if it stops
403# at a breakpoint, we will assume it is the one we want. We can't
404# just compare to "function" because it might be a fully qualified,
78a1a894
DJ
405# single quoted C++ function specifier. If there's an additional argument,
406# pass it to gdb_breakpoint.
c906108c 407
78a1a894 408proc runto { function args } {
c906108c
SS
409 global gdb_prompt
410 global decimal
411
412 delete_breakpoints
413
78a1a894 414 if ![gdb_breakpoint $function [lindex $args 0]] {
c906108c
SS
415 return 0;
416 }
417
418 gdb_run_cmd
419
420 # the "at foo.c:36" output we get with -g.
421 # the "in func" output we get without -g.
422 gdb_expect 30 {
423 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
424 return 1
425 }
426 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
427 return 1
428 }
8e46892c
JK
429 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
430 unsupported "Non-stop mode not supported"
431 return 0
432 }
569b05a5
JK
433 -re ".*A problem internal to GDB has been detected" {
434 fail "running to $function in runto (GDB internal error)"
435 gdb_internal_error_resync
436 return 0
437 }
c906108c
SS
438 -re "$gdb_prompt $" {
439 fail "running to $function in runto"
440 return 0
441 }
72c63395
JK
442 eof {
443 fail "running to $function in runto (end of file)"
444 return 0
445 }
c906108c
SS
446 timeout {
447 fail "running to $function in runto (timeout)"
448 return 0
449 }
450 }
451 return 1
452}
453
454#
455# runto_main -- ask gdb to run until we hit a breakpoint at main.
456# The case where the target uses stubs has to be handled
457# specially--if it uses stubs, assuming we hit
458# breakpoint() and just step out of the function.
459#
460proc runto_main { } {
461 global gdb_prompt
462 global decimal
463
464 if ![target_info exists gdb_stub] {
465 return [runto main]
466 }
467
468 delete_breakpoints
469
470 gdb_step_for_stub;
471
472 return 1
473}
474
7a292a7a 475
4ce44c66
JM
476### Continue, and expect to hit a breakpoint.
477### Report a pass or fail, depending on whether it seems to have
478### worked. Use NAME as part of the test name; each call to
479### continue_to_breakpoint should use a NAME which is unique within
480### that test file.
74960c60 481proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
4ce44c66
JM
482 global gdb_prompt
483 set full_name "continue to breakpoint: $name"
484
485 send_gdb "continue\n"
486 gdb_expect {
b02a33db 487 -re "Breakpoint .* (at|in) $location_pattern\r\n$gdb_prompt $" {
4ce44c66
JM
488 pass $full_name
489 }
490 -re ".*$gdb_prompt $" {
491 fail $full_name
492 }
493 timeout {
494 fail "$full_name (timeout)"
495 }
496 }
497}
498
499
039cf96d
AC
500# gdb_internal_error_resync:
501#
502# Answer the questions GDB asks after it reports an internal error
503# until we get back to a GDB prompt. Decline to quit the debugging
504# session, and decline to create a core file. Return non-zero if the
505# resync succeeds.
506#
507# This procedure just answers whatever questions come up until it sees
508# a GDB prompt; it doesn't require you to have matched the input up to
509# any specific point. However, it only answers questions it sees in
510# the output itself, so if you've matched a question, you had better
511# answer it yourself before calling this.
512#
513# You can use this function thus:
514#
515# gdb_expect {
516# ...
517# -re ".*A problem internal to GDB has been detected" {
518# gdb_internal_error_resync
519# }
520# ...
521# }
522#
523proc gdb_internal_error_resync {} {
524 global gdb_prompt
525
526 set count 0
527 while {$count < 10} {
528 gdb_expect {
529 -re "Quit this debugging session\\? \\(y or n\\) $" {
530 send_gdb "n\n"
531 incr count
532 }
533 -re "Create a core file of GDB\\? \\(y or n\\) $" {
534 send_gdb "n\n"
535 incr count
536 }
537 -re "$gdb_prompt $" {
538 # We're resynchronized.
539 return 1
540 }
541 timeout {
542 perror "Could not resync from internal error (timeout)"
543 return 0
544 }
545 }
546 }
2b211c59
AC
547 perror "Could not resync from internal error (resync count exceeded)"
548 return 0
039cf96d
AC
549}
550
4ce44c66 551
2307bd6a 552# gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
8dbfb380 553# Send a command to gdb; test the result.
c906108c
SS
554#
555# COMMAND is the command to execute, send to GDB with send_gdb. If
556# this is the null string no command is sent.
2307bd6a
DJ
557# MESSAGE is a message to be printed with the built-in failure patterns
558# if one of them matches. If MESSAGE is empty COMMAND will be used.
559# EXPECT_ARGUMENTS will be fed to expect in addition to the standard
560# patterns. Pattern elements will be evaluated in the caller's
561# context; action elements will be executed in the caller's context.
562# Unlike patterns for gdb_test, these patterns should generally include
563# the final newline and prompt.
c906108c
SS
564#
565# Returns:
2307bd6a
DJ
566# 1 if the test failed, according to a built-in failure pattern
567# 0 if only user-supplied patterns matched
c906108c
SS
568# -1 if there was an internal error.
569#
d422fe19
AC
570# You can use this function thus:
571#
572# gdb_test_multiple "print foo" "test foo" {
573# -re "expected output 1" {
574# pass "print foo"
575# }
576# -re "expected output 2" {
577# fail "print foo"
578# }
579# }
580#
fda326dd 581# The standard patterns, such as "Inferior exited..." and "A problem
d422fe19
AC
582# ...", all being implicitly appended to that list.
583#
2307bd6a 584proc gdb_test_multiple { command message user_code } {
c906108c
SS
585 global verbose
586 global gdb_prompt
587 global GDB
fda326dd 588 global inferior_exited_re
c906108c 589 upvar timeout timeout
c47cebdb 590 upvar expect_out expect_out
c906108c 591
2307bd6a
DJ
592 if { $message == "" } {
593 set message $command
c906108c 594 }
c906108c 595
824cc8dd
JK
596 if [string match "*\[\r\n\]" $command] {
597 error "Invalid trailing newline in \"$message\" test"
598 }
599
8344e389
JK
600 if [string match "*\[\r\n\]*" $message] {
601 error "Invalid newline in \"$message\" test"
602 }
603
2307bd6a
DJ
604 # TCL/EXPECT WART ALERT
605 # Expect does something very strange when it receives a single braced
606 # argument. It splits it along word separators and performs substitutions.
607 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
608 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
609 # double-quoted list item, "\[ab\]" is just a long way of representing
610 # "[ab]", because the backslashes will be removed by lindex.
611
612 # Unfortunately, there appears to be no easy way to duplicate the splitting
613 # that expect will do from within TCL. And many places make use of the
614 # "\[0-9\]" construct, so we need to support that; and some places make use
615 # of the "[func]" construct, so we need to support that too. In order to
616 # get this right we have to substitute quoted list elements differently
617 # from braced list elements.
618
619 # We do this roughly the same way that Expect does it. We have to use two
620 # lists, because if we leave unquoted newlines in the argument to uplevel
621 # they'll be treated as command separators, and if we escape newlines
622 # we mangle newlines inside of command blocks. This assumes that the
623 # input doesn't contain a pattern which contains actual embedded newlines
624 # at this point!
625
626 regsub -all {\n} ${user_code} { } subst_code
627 set subst_code [uplevel list $subst_code]
628
629 set processed_code ""
630 set patterns ""
631 set expecting_action 0
21e24d21 632 set expecting_arg 0
2307bd6a
DJ
633 foreach item $user_code subst_item $subst_code {
634 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
635 lappend processed_code $item
636 continue
637 }
21e24d21
PA
638 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
639 lappend processed_code $item
640 continue
641 }
642 if { $item == "-timeout" } {
643 set expecting_arg 1
644 lappend processed_code $item
645 continue
646 }
647 if { $expecting_arg } {
648 set expecting_arg 0
2307bd6a
DJ
649 lappend processed_code $item
650 continue
651 }
652 if { $expecting_action } {
653 lappend processed_code "uplevel [list $item]"
654 set expecting_action 0
655 # Cosmetic, no effect on the list.
656 append processed_code "\n"
657 continue
658 }
659 set expecting_action 1
660 lappend processed_code $subst_item
661 if {$patterns != ""} {
662 append patterns "; "
663 }
664 append patterns "\"$subst_item\""
c906108c
SS
665 }
666
2307bd6a
DJ
667 # Also purely cosmetic.
668 regsub -all {\r} $patterns {\\r} patterns
669 regsub -all {\n} $patterns {\\n} patterns
670
c906108c
SS
671 if $verbose>2 then {
672 send_user "Sending \"$command\" to gdb\n"
2307bd6a 673 send_user "Looking to match \"$patterns\"\n"
c906108c
SS
674 send_user "Message is \"$message\"\n"
675 }
676
677 set result -1
678 set string "${command}\n";
679 if { $command != "" } {
680 while { "$string" != "" } {
681 set foo [string first "\n" "$string"];
682 set len [string length "$string"];
683 if { $foo < [expr $len - 1] } {
684 set str [string range "$string" 0 $foo];
685 if { [send_gdb "$str"] != "" } {
686 global suppress_flag;
687
688 if { ! $suppress_flag } {
689 perror "Couldn't send $command to GDB.";
690 }
691 fail "$message";
692 return $result;
693 }
a0b3c4fd
JM
694 # since we're checking if each line of the multi-line
695 # command are 'accepted' by GDB here,
696 # we need to set -notransfer expect option so that
697 # command output is not lost for pattern matching
698 # - guo
5f279fa6
DJ
699 gdb_expect 2 {
700 -notransfer -re "\[\r\n\]" { verbose "partial: match" 3 }
701 timeout { verbose "partial: timeout" 3 }
c906108c
SS
702 }
703 set string [string range "$string" [expr $foo + 1] end];
704 } else {
705 break;
706 }
707 }
708 if { "$string" != "" } {
709 if { [send_gdb "$string"] != "" } {
710 global suppress_flag;
711
712 if { ! $suppress_flag } {
713 perror "Couldn't send $command to GDB.";
714 }
715 fail "$message";
716 return $result;
717 }
718 }
719 }
720
9d2e1bab
ND
721 if [target_info exists gdb,timeout] {
722 set tmt [target_info gdb,timeout];
c906108c 723 } else {
c906108c
SS
724 if [info exists timeout] {
725 set tmt $timeout;
726 } else {
9d2e1bab
ND
727 global timeout;
728 if [info exists timeout] {
729 set tmt $timeout;
730 } else {
731 set tmt 60;
732 }
c906108c
SS
733 }
734 }
2307bd6a
DJ
735
736 set code {
039cf96d
AC
737 -re ".*A problem internal to GDB has been detected" {
738 fail "$message (GDB internal error)"
739 gdb_internal_error_resync
740 }
c906108c
SS
741 -re "\\*\\*\\* DOSEXIT code.*" {
742 if { $message != "" } {
743 fail "$message";
744 }
745 gdb_suppress_entire_file "GDB died";
2307bd6a 746 set result -1;
c906108c 747 }
b0f4b84b
DJ
748 }
749 append code $processed_code
750 append code {
9e0b60a8 751 -re "Ending remote debugging.*$gdb_prompt $" {
c906108c
SS
752 if ![isnative] then {
753 warning "Can`t communicate to remote target."
754 }
755 gdb_exit
756 gdb_start
757 set result -1
758 }
9e0b60a8 759 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
c906108c 760 perror "Undefined command \"$command\"."
9e0b60a8 761 fail "$message"
c906108c
SS
762 set result 1
763 }
764 -re "Ambiguous command.*$gdb_prompt $" {
765 perror "\"$command\" is not a unique command name."
9e0b60a8 766 fail "$message"
c906108c
SS
767 set result 1
768 }
fda326dd 769 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
c906108c 770 if ![string match "" $message] then {
ed4c619a 771 set errmsg "$message (the program exited)"
c906108c 772 } else {
ed4c619a 773 set errmsg "$command (the program exited)"
c906108c
SS
774 }
775 fail "$errmsg"
2307bd6a 776 set result -1
cb9a9d3e 777 }
fda326dd 778 -re "$inferior_exited_re normally.*$gdb_prompt $" {
cb9a9d3e 779 if ![string match "" $message] then {
ed4c619a 780 set errmsg "$message (the program exited)"
cb9a9d3e 781 } else {
ed4c619a 782 set errmsg "$command (the program exited)"
cb9a9d3e
MS
783 }
784 fail "$errmsg"
2307bd6a 785 set result -1
c906108c
SS
786 }
787 -re "The program is not being run.*$gdb_prompt $" {
788 if ![string match "" $message] then {
ed4c619a 789 set errmsg "$message (the program is no longer running)"
c906108c 790 } else {
ed4c619a 791 set errmsg "$command (the program is no longer running)"
c906108c
SS
792 }
793 fail "$errmsg"
2307bd6a 794 set result -1
c906108c 795 }
734b8fe8 796 -re "\r\n$gdb_prompt $" {
c906108c
SS
797 if ![string match "" $message] then {
798 fail "$message"
799 }
800 set result 1
801 }
802 "<return>" {
803 send_gdb "\n"
804 perror "Window too small."
9e0b60a8 805 fail "$message"
2307bd6a 806 set result -1
c906108c 807 }
b598bfda 808 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
c906108c 809 send_gdb "n\n"
b598bfda
DJ
810 gdb_expect -re "$gdb_prompt $"
811 fail "$message (got interactive prompt)"
812 set result -1
813 }
814 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
815 send_gdb "0\n"
816 gdb_expect -re "$gdb_prompt $"
817 fail "$message (got breakpoint menu)"
2307bd6a 818 set result -1
c906108c
SS
819 }
820 eof {
821 perror "Process no longer exists"
822 if { $message != "" } {
823 fail "$message"
824 }
825 return -1
826 }
827 full_buffer {
828 perror "internal buffer is full."
9e0b60a8 829 fail "$message"
2307bd6a 830 set result -1
c906108c
SS
831 }
832 timeout {
833 if ![string match "" $message] then {
834 fail "$message (timeout)"
835 }
836 set result 1
837 }
838 }
2307bd6a
DJ
839
840 set result 0
04f6ecf2
DJ
841 set code [catch {gdb_expect $tmt $code} string]
842 if {$code == 1} {
843 global errorInfo errorCode;
844 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
845 } elseif {$code == 2} {
846 return -code return $string
847 } elseif {$code == 3} {
848 return
849 } elseif {$code > 4} {
850 return -code $code $string
851 }
c906108c
SS
852 return $result
853}
2307bd6a
DJ
854
855# gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
856# Send a command to gdb; test the result.
857#
858# COMMAND is the command to execute, send to GDB with send_gdb. If
859# this is the null string no command is sent.
860# PATTERN is the pattern to match for a PASS, and must NOT include
861# the \r\n sequence immediately before the gdb prompt.
862# MESSAGE is an optional message to be printed. If this is
863# omitted, then the pass/fail messages use the command string as the
864# message. (If this is the empty string, then sometimes we don't
865# call pass or fail at all; I don't understand this at all.)
866# QUESTION is a question GDB may ask in response to COMMAND, like
867# "are you sure?"
868# RESPONSE is the response to send if QUESTION appears.
869#
870# Returns:
871# 1 if the test failed,
872# 0 if the test passes,
873# -1 if there was an internal error.
874#
875proc gdb_test { args } {
876 global verbose
877 global gdb_prompt
878 global GDB
879 upvar timeout timeout
880
881 if [llength $args]>2 then {
882 set message [lindex $args 2]
883 } else {
884 set message [lindex $args 0]
885 }
886 set command [lindex $args 0]
887 set pattern [lindex $args 1]
888
889 if [llength $args]==5 {
890 set question_string [lindex $args 3];
891 set response_string [lindex $args 4];
892 } else {
893 set question_string "^FOOBAR$"
894 }
895
896 return [gdb_test_multiple $command $message {
897 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
898 if ![string match "" $message] then {
899 pass "$message"
900 }
901 }
902 -re "(${question_string})$" {
903 send_gdb "$response_string\n";
904 exp_continue;
905 }
906 }]
907}
a7b75dfd
JB
908
909# gdb_test_no_output COMMAND MESSAGE
910# Send a command to GDB and verify that this command generated no output.
911#
912# See gdb_test_multiple for a description of the COMMAND and MESSAGE
913# parameters. If MESSAGE is ommitted, then COMMAND will be used as
c22decce
JB
914# the message. (If MESSAGE is the empty string, then sometimes we do not
915# call pass or fail at all; I don't understand this at all.)
a7b75dfd
JB
916
917proc gdb_test_no_output { args } {
918 global gdb_prompt
919 set command [lindex $args 0]
920 if [llength $args]>1 then {
921 set message [lindex $args 1]
922 } else {
923 set message $command
924 }
925
926 set command_regex [string_to_regexp $command]
927 gdb_test_multiple $command $message {
928 -re "^$command_regex\r\n$gdb_prompt $" {
c22decce
JB
929 if ![string match "" $message] then {
930 pass "$message"
931 }
a7b75dfd
JB
932 }
933 }
934}
935
6b0ecdc2
DE
936# Send a command and then wait for a sequence of outputs.
937# This is useful when the sequence is long and contains ".*", a single
938# regexp to match the entire output can get a timeout much easier.
939#
940# COMMAND is the command to send.
941# TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
942# EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
943# processed in order, and all must be present in the output.
944#
945# It is unnecessary to specify ".*" at the beginning or end of any regexp,
946# there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
947# There is also an implicit ".*" between the last regexp and the gdb prompt.
948#
949# Like gdb_test and gdb_test_multiple, the output is expected to end with the
950# gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
5fa290c1
DE
951#
952# Returns:
953# 1 if the test failed,
954# 0 if the test passes,
955# -1 if there was an internal error.
6b0ecdc2
DE
956
957proc gdb_test_sequence { command test_name expected_output_list } {
958 global gdb_prompt
959 if { $test_name == "" } {
960 set test_name $command
961 }
962 lappend expected_output_list ""; # implicit ".*" before gdb prompt
963 send_gdb "$command\n"
5fa290c1 964 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
6b0ecdc2
DE
965}
966
c906108c
SS
967\f
968# Test that a command gives an error. For pass or fail, return
969# a 1 to indicate that more tests can proceed. However a timeout
970# is a serious error, generates a special fail message, and causes
971# a 0 to be returned to indicate that more tests are likely to fail
972# as well.
973
974proc test_print_reject { args } {
975 global gdb_prompt
976 global verbose
977
978 if [llength $args]==2 then {
979 set expectthis [lindex $args 1]
980 } else {
981 set expectthis "should never match this bogus string"
982 }
983 set sendthis [lindex $args 0]
984 if $verbose>2 then {
985 send_user "Sending \"$sendthis\" to gdb\n"
986 send_user "Looking to match \"$expectthis\"\n"
987 }
988 send_gdb "$sendthis\n"
989 #FIXME: Should add timeout as parameter.
990 gdb_expect {
991 -re "A .* in expression.*\\.*$gdb_prompt $" {
992 pass "reject $sendthis"
993 return 1
994 }
995 -re "Invalid syntax in expression.*$gdb_prompt $" {
996 pass "reject $sendthis"
997 return 1
998 }
999 -re "Junk after end of expression.*$gdb_prompt $" {
1000 pass "reject $sendthis"
1001 return 1
1002 }
1003 -re "Invalid number.*$gdb_prompt $" {
1004 pass "reject $sendthis"
1005 return 1
1006 }
1007 -re "Invalid character constant.*$gdb_prompt $" {
1008 pass "reject $sendthis"
1009 return 1
1010 }
1011 -re "No symbol table is loaded.*$gdb_prompt $" {
1012 pass "reject $sendthis"
1013 return 1
1014 }
1015 -re "No symbol .* in current context.*$gdb_prompt $" {
1016 pass "reject $sendthis"
1017 return 1
1018 }
c4b7bc2b
JB
1019 -re "Unmatched single quote.*$gdb_prompt $" {
1020 pass "reject $sendthis"
1021 return 1
1022 }
1023 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1024 pass "reject $sendthis"
1025 return 1
1026 }
c906108c
SS
1027 -re "$expectthis.*$gdb_prompt $" {
1028 pass "reject $sendthis"
1029 return 1
1030 }
1031 -re ".*$gdb_prompt $" {
1032 fail "reject $sendthis"
1033 return 1
1034 }
1035 default {
1036 fail "reject $sendthis (eof or timeout)"
1037 return 0
1038 }
1039 }
1040}
1041\f
1042# Given an input string, adds backslashes as needed to create a
1043# regexp that will match the string.
1044
1045proc string_to_regexp {str} {
1046 set result $str
39fb8e9e 1047 regsub -all {[]*+.|()^$\[\\]} $str {\\&} result
c906108c
SS
1048 return $result
1049}
1050
1051# Same as gdb_test, but the second parameter is not a regexp,
1052# but a string that must match exactly.
1053
1054proc gdb_test_exact { args } {
1055 upvar timeout timeout
1056
1057 set command [lindex $args 0]
1058
1059 # This applies a special meaning to a null string pattern. Without
1060 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1061 # messages from commands that should have no output except a new
1062 # prompt. With this, only results of a null string will match a null
1063 # string pattern.
1064
1065 set pattern [lindex $args 1]
1066 if [string match $pattern ""] {
1067 set pattern [string_to_regexp [lindex $args 0]]
1068 } else {
1069 set pattern [string_to_regexp [lindex $args 1]]
1070 }
1071
1072 # It is most natural to write the pattern argument with only
1073 # embedded \n's, especially if you are trying to avoid Tcl quoting
1074 # problems. But gdb_expect really wants to see \r\n in patterns. So
1075 # transform the pattern here. First transform \r\n back to \n, in
1076 # case some users of gdb_test_exact already do the right thing.
1077 regsub -all "\r\n" $pattern "\n" pattern
1078 regsub -all "\n" $pattern "\r\n" pattern
1079 if [llength $args]==3 then {
1080 set message [lindex $args 2]
1081 } else {
1082 set message $command
1083 }
1084
1085 return [gdb_test $command $pattern $message]
1086}
2dfb8c17
DE
1087
1088# Wrapper around gdb_test_multiple that looks for a list of expected
1089# output elements, but which can appear in any order.
1090# CMD is the gdb command.
1091# NAME is the name of the test.
1092# ELM_FIND_REGEXP specifies how to partition the output into elements to
1093# compare.
1094# ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1095# RESULT_MATCH_LIST is a list of exact matches for each expected element.
1096# All elements of RESULT_MATCH_LIST must appear for the test to pass.
1097#
1098# A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1099# of text per element and then strip trailing \r\n's.
1100# Example:
1101# gdb_test_list_exact "foo" "bar" \
eec52c44
PM
1102# "\[^\r\n\]+\[\r\n\]+" \
1103# "\[^\r\n\]+" \
2dfb8c17
DE
1104# { \
1105# {expected result 1} \
1106# {expected result 2} \
1107# }
1108
1109proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1110 global gdb_prompt
1111
1112 set matches [lsort $result_match_list]
1113 set seen {}
1114 gdb_test_multiple $cmd $name {
1115 "$cmd\[\r\n\]" { exp_continue }
1116 -re $elm_find_regexp {
1117 set str $expect_out(0,string)
1118 verbose -log "seen: $str" 3
1119 regexp -- $elm_extract_regexp $str elm_seen
1120 verbose -log "extracted: $elm_seen" 3
1121 lappend seen $elm_seen
1122 exp_continue
1123 }
1124 -re "$gdb_prompt $" {
1125 set failed ""
1126 foreach got [lsort $seen] have $matches {
1127 if {![string equal $got $have]} {
1128 set failed $have
1129 break
1130 }
1131 }
1132 if {[string length $failed] != 0} {
1133 fail "$name ($failed not found)"
1134 } else {
1135 pass $name
1136 }
1137 }
1138 }
1139}
c906108c
SS
1140\f
1141proc gdb_reinitialize_dir { subdir } {
1142 global gdb_prompt
1143
1144 if [is_remote host] {
1145 return "";
1146 }
1147 send_gdb "dir\n"
1148 gdb_expect 60 {
1149 -re "Reinitialize source path to empty.*y or n. " {
1150 send_gdb "y\n"
1151 gdb_expect 60 {
1152 -re "Source directories searched.*$gdb_prompt $" {
1153 send_gdb "dir $subdir\n"
1154 gdb_expect 60 {
1155 -re "Source directories searched.*$gdb_prompt $" {
1156 verbose "Dir set to $subdir"
1157 }
1158 -re "$gdb_prompt $" {
1159 perror "Dir \"$subdir\" failed."
1160 }
1161 }
1162 }
1163 -re "$gdb_prompt $" {
1164 perror "Dir \"$subdir\" failed."
1165 }
1166 }
1167 }
1168 -re "$gdb_prompt $" {
1169 perror "Dir \"$subdir\" failed."
1170 }
1171 }
1172}
1173
1174#
1175# gdb_exit -- exit the GDB, killing the target program if necessary
1176#
1177proc default_gdb_exit {} {
1178 global GDB
6b8ce727 1179 global INTERNAL_GDBFLAGS GDBFLAGS
c906108c
SS
1180 global verbose
1181 global gdb_spawn_id;
1182
1183 gdb_stop_suppressing_tests;
1184
1185 if ![info exists gdb_spawn_id] {
1186 return;
1187 }
1188
6b8ce727 1189 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
c906108c
SS
1190
1191 if { [is_remote host] && [board_info host exists fileid] } {
1192 send_gdb "quit\n";
1193 gdb_expect 10 {
1194 -re "y or n" {
1195 send_gdb "y\n";
1196 exp_continue;
1197 }
1198 -re "DOSEXIT code" { }
1199 default { }
1200 }
1201 }
1202
1203 if ![is_remote host] {
1204 remote_close host;
1205 }
1206 unset gdb_spawn_id
1207}
1208
3e3ffd2b 1209# Load a file into the debugger.
2db8e78e 1210# The return value is 0 for success, -1 for failure.
c906108c 1211#
2db8e78e
MC
1212# This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1213# to one of these values:
3e3ffd2b 1214#
2db8e78e
MC
1215# debug file was loaded successfully and has debug information
1216# nodebug file was loaded successfully and has no debug information
1217# fail file was not loaded
c906108c 1218#
2db8e78e
MC
1219# I tried returning this information as part of the return value,
1220# but ran into a mess because of the many re-implementations of
1221# gdb_load in config/*.exp.
3e3ffd2b 1222#
2db8e78e
MC
1223# TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1224# this if they can get more information set.
3e3ffd2b 1225
c906108c 1226proc gdb_file_cmd { arg } {
3e3ffd2b 1227 global gdb_prompt
c906108c 1228 global verbose
c906108c 1229 global GDB
b741e217
DJ
1230 global last_loaded_file
1231
1232 set last_loaded_file $arg
c906108c 1233
2db8e78e
MC
1234 # Set whether debug info was found.
1235 # Default to "fail".
1236 global gdb_file_cmd_debug_info
1237 set gdb_file_cmd_debug_info "fail"
1238
c906108c 1239 if [is_remote host] {
3e3ffd2b 1240 set arg [remote_download host $arg]
c906108c 1241 if { $arg == "" } {
2db8e78e
MC
1242 perror "download failed"
1243 return -1
c906108c
SS
1244 }
1245 }
1246
4c42eaff
DJ
1247 # The file command used to kill the remote target. For the benefit
1248 # of the testsuite, preserve this behavior.
1249 send_gdb "kill\n"
1250 gdb_expect 120 {
1251 -re "Kill the program being debugged. .y or n. $" {
1252 send_gdb "y\n"
1253 verbose "\t\tKilling previous program being debugged"
1254 exp_continue
1255 }
1256 -re "$gdb_prompt $" {
1257 # OK.
1258 }
1259 }
1260
c906108c
SS
1261 send_gdb "file $arg\n"
1262 gdb_expect 120 {
3e3ffd2b
MC
1263 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1264 verbose "\t\tLoaded $arg into the $GDB with no debugging symbols"
2db8e78e
MC
1265 set gdb_file_cmd_debug_info "nodebug"
1266 return 0
3e3ffd2b 1267 }
c906108c
SS
1268 -re "Reading symbols from.*done.*$gdb_prompt $" {
1269 verbose "\t\tLoaded $arg into the $GDB"
2db8e78e
MC
1270 set gdb_file_cmd_debug_info "debug"
1271 return 0
c906108c 1272 }
c906108c
SS
1273 -re "Load new symbol table from \".*\".*y or n. $" {
1274 send_gdb "y\n"
1275 gdb_expect 120 {
1276 -re "Reading symbols from.*done.*$gdb_prompt $" {
1277 verbose "\t\tLoaded $arg with new symbol table into $GDB"
2db8e78e
MC
1278 set gdb_file_cmd_debug_info "debug"
1279 return 0
c906108c
SS
1280 }
1281 timeout {
2db8e78e
MC
1282 perror "(timeout) Couldn't load $arg, other program already loaded."
1283 return -1
c906108c
SS
1284 }
1285 }
1286 }
1287 -re "No such file or directory.*$gdb_prompt $" {
2db8e78e
MC
1288 perror "($arg) No such file or directory"
1289 return -1
c906108c
SS
1290 }
1291 -re "$gdb_prompt $" {
2db8e78e
MC
1292 perror "couldn't load $arg into $GDB."
1293 return -1
c906108c
SS
1294 }
1295 timeout {
2db8e78e
MC
1296 perror "couldn't load $arg into $GDB (timed out)."
1297 return -1
c906108c
SS
1298 }
1299 eof {
1300 # This is an attempt to detect a core dump, but seems not to
1301 # work. Perhaps we need to match .* followed by eof, in which
1302 # gdb_expect does not seem to have a way to do that.
2db8e78e
MC
1303 perror "couldn't load $arg into $GDB (end of file)."
1304 return -1
c906108c
SS
1305 }
1306 }
1307}
1308
1309#
1310# start gdb -- start gdb running, default procedure
1311#
1312# When running over NFS, particularly if running many simultaneous
1313# tests on different hosts all using the same server, things can
1314# get really slow. Give gdb at least 3 minutes to start up.
1315#
1316proc default_gdb_start { } {
1317 global verbose
1318 global GDB
6b8ce727 1319 global INTERNAL_GDBFLAGS GDBFLAGS
c906108c
SS
1320 global gdb_prompt
1321 global timeout
1322 global gdb_spawn_id;
1323
1324 gdb_stop_suppressing_tests;
1325
6b8ce727 1326 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
c906108c
SS
1327
1328 if [info exists gdb_spawn_id] {
1329 return 0;
1330 }
1331
1332 if ![is_remote host] {
1333 if { [which $GDB] == 0 } then {
1334 perror "$GDB does not exist."
1335 exit 1
1336 }
1337 }
6b8ce727 1338 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"];
c906108c
SS
1339 if { $res < 0 || $res == "" } {
1340 perror "Spawning $GDB failed."
1341 return 1;
1342 }
1343 gdb_expect 360 {
1344 -re "\[\r\n\]$gdb_prompt $" {
1345 verbose "GDB initialized."
1346 }
1347 -re "$gdb_prompt $" {
1348 perror "GDB never initialized."
1349 return -1
1350 }
1351 timeout {
1352 perror "(timeout) GDB never initialized after 10 seconds."
1353 remote_close host;
1354 return -1
1355 }
1356 }
1357 set gdb_spawn_id -1;
1358 # force the height to "unlimited", so no pagers get used
1359
1360 send_gdb "set height 0\n"
1361 gdb_expect 10 {
1362 -re "$gdb_prompt $" {
1363 verbose "Setting height to 0." 2
1364 }
1365 timeout {
1366 warning "Couldn't set the height to 0"
1367 }
1368 }
1369 # force the width to "unlimited", so no wraparound occurs
1370 send_gdb "set width 0\n"
1371 gdb_expect 10 {
1372 -re "$gdb_prompt $" {
1373 verbose "Setting width to 0." 2
1374 }
1375 timeout {
1376 warning "Couldn't set the width to 0."
1377 }
1378 }
1379 return 0;
1380}
1381
ec3c07fc
NS
1382# Examine the output of compilation to determine whether compilation
1383# failed or not. If it failed determine whether it is due to missing
1384# compiler or due to compiler error. Report pass, fail or unsupported
1385# as appropriate
1386
1387proc gdb_compile_test {src output} {
1388 if { $output == "" } {
1389 pass "compilation [file tail $src]"
1390 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1391 unsupported "compilation [file tail $src]"
1392 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1393 unsupported "compilation [file tail $src]"
6bb85cd1
DE
1394 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1395 unsupported "compilation [file tail $src]"
ec3c07fc
NS
1396 } else {
1397 verbose -log "compilation failed: $output" 2
1398 fail "compilation [file tail $src]"
1399 }
1400}
1401
d4f3574e
SS
1402# Return a 1 for configurations for which we don't even want to try to
1403# test C++.
1404
1405proc skip_cplus_tests {} {
d4f3574e
SS
1406 if { [istarget "h8300-*-*"] } {
1407 return 1
1408 }
81d2cbae 1409
1146c7f1
SC
1410 # The C++ IO streams are too large for HC11/HC12 and are thus not
1411 # available. The gdb C++ tests use them and don't compile.
1412 if { [istarget "m6811-*-*"] } {
1413 return 1
1414 }
1415 if { [istarget "m6812-*-*"] } {
1416 return 1
1417 }
d4f3574e
SS
1418 return 0
1419}
1420
759f0f0b
PA
1421# Return a 1 for configurations for which don't have both C++ and the STL.
1422
1423proc skip_stl_tests {} {
1424 # Symbian supports the C++ language, but the STL is missing
1425 # (both headers and libraries).
1426 if { [istarget "arm*-*-symbianelf*"] } {
1427 return 1
1428 }
1429
1430 return [skip_cplus_tests]
1431}
1432
89a237cb
MC
1433# Return a 1 if I don't even want to try to test FORTRAN.
1434
1435proc skip_fortran_tests {} {
1436 return 0
1437}
1438
ec3c07fc
NS
1439# Return a 1 if I don't even want to try to test ada.
1440
1441proc skip_ada_tests {} {
1442 return 0
1443}
1444
1445# Return a 1 if I don't even want to try to test java.
1446
1447proc skip_java_tests {} {
1448 return 0
1449}
1450
f6bbabf0
PM
1451# Return a 1 for configurations that do not support Python scripting.
1452
1453proc skip_python_tests {} {
1454 global gdb_prompt
1455 gdb_test_multiple "python print 'test'" "verify python support" {
1456 -re "not supported.*$gdb_prompt $" {
1457 unsupported "Python support is disabled."
1458 return 1
1459 }
1460 -re "$gdb_prompt $" {}
1461 }
1462
1463 return 0
1464}
1465
93f02886
DJ
1466# Return a 1 if we should skip shared library tests.
1467
1468proc skip_shlib_tests {} {
1469 # Run the shared library tests on native systems.
1470 if {[isnative]} {
1471 return 0
1472 }
1473
1474 # An abbreviated list of remote targets where we should be able to
1475 # run shared library tests.
1476 if {([istarget *-*-linux*]
1477 || [istarget *-*-*bsd*]
1478 || [istarget *-*-solaris2*]
1479 || [istarget arm*-*-symbianelf*]
1480 || [istarget *-*-mingw*]
1481 || [istarget *-*-cygwin*]
1482 || [istarget *-*-pe*])} {
1483 return 0
1484 }
1485
1486 return 1
1487}
1488
e43ec454
YQ
1489# Return 1 if _Complex types are supported, otherwise, return 0.
1490
1491proc support_complex_tests {} {
1492 global support_complex_tests_saved
1493
1494 # Use the cached value, if it exists.
1495 if [info exists support_complex_tests_saved] {
1496 verbose "returning saved $support_complex_tests_saved" 2
1497 return $support_complex_tests_saved
1498 }
1499
1500 # Set up, compile, and execute a test program containing _Complex types.
1501 # Include the current process ID in the file names to prevent conflicts
1502 # with invocations for multiple testsuites.
1503 set src complex[pid].c
1504 set exe complex[pid].x
1505
1506 set f [open $src "w"]
1507 puts $f "int main() {"
1508 puts $f "_Complex float cf;"
1509 puts $f "_Complex double cd;"
1510 puts $f "_Complex long double cld;"
1511 puts $f " return 0; }"
1512 close $f
1513
1514 verbose "compiling testfile $src" 2
1515 set compile_flags {debug nowarnings quiet}
1516 set lines [gdb_compile $src $exe executable $compile_flags]
1517 file delete $src
1518 file delete $exe
1519
1520 if ![string match "" $lines] then {
1521 verbose "testfile compilation failed, returning 0" 2
1522 set support_complex_tests_saved 0
1523 } else {
1524 set support_complex_tests_saved 1
1525 }
1526
1527 return $support_complex_tests_saved
1528}
1529
add265ae
L
1530# Return 1 if target is ILP32.
1531# This cannot be decided simply from looking at the target string,
1532# as it might depend on externally passed compiler options like -m64.
1533proc is_ilp32_target {} {
1534 global is_ilp32_target_saved
1535
1536 # Use the cached value, if it exists. Cache value per "board" to handle
1537 # runs with multiple options (e.g. unix/{-m32,-64}) correctly.
1538 set me "is_ilp32_target"
1539 set board [target_info name]
1540 if [info exists is_ilp32_target_saved($board)] {
1541 verbose "$me: returning saved $is_ilp32_target_saved($board)" 2
1542 return $is_ilp32_target_saved($board)
1543 }
1544
1545
1546 set src ilp32[pid].c
1547 set obj ilp32[pid].o
1548
1549 set f [open $src "w"]
1550 puts $f "int dummy\[sizeof (int) == 4"
1551 puts $f " && sizeof (void *) == 4"
1552 puts $f " && sizeof (long) == 4 ? 1 : -1\];"
1553 close $f
1554
1555 verbose "$me: compiling testfile $src" 2
1556 set lines [gdb_compile $src $obj object {quiet}]
1557 file delete $src
1558 file delete $obj
1559
1560 if ![string match "" $lines] then {
1561 verbose "$me: testfile compilation failed, returning 0" 2
1562 return [set is_ilp32_target_saved($board) 0]
1563 }
1564
1565 verbose "$me: returning 1" 2
1566 return [set is_ilp32_target_saved($board) 1]
1567}
1568
1569# Return 1 if target is LP64.
1570# This cannot be decided simply from looking at the target string,
1571# as it might depend on externally passed compiler options like -m64.
1572proc is_lp64_target {} {
1573 global is_lp64_target_saved
1574
1575 # Use the cached value, if it exists. Cache value per "board" to handle
1576 # runs with multiple options (e.g. unix/{-m32,-64}) correctly.
1577 set me "is_lp64_target"
1578 set board [target_info name]
1579 if [info exists is_lp64_target_saved($board)] {
1580 verbose "$me: returning saved $is_lp64_target_saved($board)" 2
1581 return $is_lp64_target_saved($board)
1582 }
1583
1584 set src lp64[pid].c
1585 set obj lp64[pid].o
1586
1587 set f [open $src "w"]
1588 puts $f "int dummy\[sizeof (int) == 4"
1589 puts $f " && sizeof (void *) == 8"
1590 puts $f " && sizeof (long) == 8 ? 1 : -1\];"
1591 close $f
1592
1593 verbose "$me: compiling testfile $src" 2
1594 set lines [gdb_compile $src $obj object {quiet}]
1595 file delete $src
1596 file delete $obj
1597
1598 if ![string match "" $lines] then {
1599 verbose "$me: testfile compilation failed, returning 0" 2
1600 return [set is_lp64_target_saved($board) 0]
1601 }
1602
1603 verbose "$me: returning 1" 2
1604 return [set is_lp64_target_saved($board) 1]
1605}
1606
6edba76f
TT
1607# Return 1 if this target is an x86 or x86-64 with -m32.
1608proc is_x86_like_target {} {
1609 if {[istarget i?86-*]} {
1610 return 1
1611 }
1612 if {![istarget "x86_64-*-*"]} {
1613 return 0
1614 }
1615 return [is_ilp32_target]
1616}
1617
be777e08
YQ
1618# Return 1 if displaced stepping is supported on target, otherwise, return 0.
1619proc support_displaced_stepping {} {
1620
1621 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
1622 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
1623 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"] } {
1624 return 1
1625 }
1626
1627 return 0
1628}
1629
3c95e6af
PG
1630# Run a test on the target to see if it supports vmx hardware. Return 0 if so,
1631# 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
1632
1633proc skip_altivec_tests {} {
1634 global skip_vmx_tests_saved
fda326dd 1635 global srcdir subdir gdb_prompt inferior_exited_re
3c95e6af
PG
1636
1637 # Use the cached value, if it exists.
1638 set me "skip_altivec_tests"
1639 if [info exists skip_vmx_tests_saved] {
1640 verbose "$me: returning saved $skip_vmx_tests_saved" 2
1641 return $skip_vmx_tests_saved
1642 }
1643
1644 # Some simulators are known to not support VMX instructions.
1645 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
1646 verbose "$me: target known to not support VMX, returning 1" 2
476308bf 1647 return [set skip_vmx_tests_saved 1]
3c95e6af
PG
1648 }
1649
1650 # Make sure we have a compiler that understands altivec.
fc91c6c2 1651 set compile_flags {debug nowarnings}
3c95e6af
PG
1652 if [get_compiler_info not-used] {
1653 warning "Could not get compiler info"
1654 return 1
1655 }
1656 if [test_compiler_info gcc*] {
1657 set compile_flags "$compile_flags additional_flags=-maltivec"
1658 } elseif [test_compiler_info xlc*] {
1659 set compile_flags "$compile_flags additional_flags=-qaltivec"
1660 } else {
1661 verbose "Could not compile with altivec support, returning 1" 2
1662 return 1
1663 }
1664
1665 # Set up, compile, and execute a test program containing VMX instructions.
1666 # Include the current process ID in the file names to prevent conflicts
1667 # with invocations for multiple testsuites.
1668 set src vmx[pid].c
1669 set exe vmx[pid].x
1670
1671 set f [open $src "w"]
1672 puts $f "int main() {"
1673 puts $f "#ifdef __MACH__"
1674 puts $f " asm volatile (\"vor v0,v0,v0\");"
1675 puts $f "#else"
1676 puts $f " asm volatile (\"vor 0,0,0\");"
1677 puts $f "#endif"
1678 puts $f " return 0; }"
1679 close $f
1680
1681 verbose "$me: compiling testfile $src" 2
1682 set lines [gdb_compile $src $exe executable $compile_flags]
1683 file delete $src
1684
1685 if ![string match "" $lines] then {
1686 verbose "$me: testfile compilation failed, returning 1" 2
1687 return [set skip_vmx_tests_saved 1]
1688 }
1689
1690 # No error message, compilation succeeded so now run it via gdb.
1691
1692 gdb_exit
1693 gdb_start
1694 gdb_reinitialize_dir $srcdir/$subdir
1695 gdb_load "$exe"
1696 gdb_run_cmd
1697 gdb_expect {
1698 -re ".*Illegal instruction.*${gdb_prompt} $" {
1699 verbose -log "\n$me altivec hardware not detected"
1700 set skip_vmx_tests_saved 1
1701 }
fda326dd 1702 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3c95e6af
PG
1703 verbose -log "\n$me: altivec hardware detected"
1704 set skip_vmx_tests_saved 0
1705 }
1706 default {
1707 warning "\n$me: default case taken"
1708 set skip_vmx_tests_saved 1
1709 }
1710 }
1711 gdb_exit
1712 remote_file build delete $exe
1713
1714 verbose "$me: returning $skip_vmx_tests_saved" 2
1715 return $skip_vmx_tests_saved
1716}
1717
604c2f83
LM
1718# Run a test on the target to see if it supports vmx hardware. Return 0 if so,
1719# 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
1720
1721proc skip_vsx_tests {} {
1722 global skip_vsx_tests_saved
fda326dd 1723 global srcdir subdir gdb_prompt inferior_exited_re
604c2f83
LM
1724
1725 # Use the cached value, if it exists.
1726 set me "skip_vsx_tests"
1727 if [info exists skip_vsx_tests_saved] {
1728 verbose "$me: returning saved $skip_vsx_tests_saved" 2
1729 return $skip_vsx_tests_saved
1730 }
1731
1732 # Some simulators are known to not support Altivec instructions, so
1733 # they won't support VSX instructions as well.
1734 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
1735 verbose "$me: target known to not support VSX, returning 1" 2
1736 return [set skip_vsx_tests_saved 1]
1737 }
1738
1739 # Make sure we have a compiler that understands altivec.
1740 set compile_flags {debug nowarnings quiet}
1741 if [get_compiler_info not-used] {
1742 warning "Could not get compiler info"
1743 return 1
1744 }
1745 if [test_compiler_info gcc*] {
1746 set compile_flags "$compile_flags additional_flags=-mvsx"
1747 } elseif [test_compiler_info xlc*] {
d9492458 1748 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
604c2f83
LM
1749 } else {
1750 verbose "Could not compile with vsx support, returning 1" 2
1751 return 1
1752 }
1753
1754 set src vsx[pid].c
1755 set exe vsx[pid].x
1756
1757 set f [open $src "w"]
1758 puts $f "int main() {"
d9492458 1759 puts $f " double a\[2\] = { 1.0, 2.0 };"
604c2f83 1760 puts $f "#ifdef __MACH__"
d9492458 1761 puts $f " asm volatile (\"lxvd2x v0,v0,%\[addr\]\" : : \[addr\] \"r\" (a));"
604c2f83 1762 puts $f "#else"
d9492458 1763 puts $f " asm volatile (\"lxvd2x 0,0,%\[addr\]\" : : \[addr\] \"r\" (a));"
604c2f83
LM
1764 puts $f "#endif"
1765 puts $f " return 0; }"
1766 close $f
1767
1768 verbose "$me: compiling testfile $src" 2
1769 set lines [gdb_compile $src $exe executable $compile_flags]
1770 file delete $src
1771
1772 if ![string match "" $lines] then {
1773 verbose "$me: testfile compilation failed, returning 1" 2
1774 return [set skip_vsx_tests_saved 1]
1775 }
1776
1777 # No error message, compilation succeeded so now run it via gdb.
1778
1779 gdb_exit
1780 gdb_start
1781 gdb_reinitialize_dir $srcdir/$subdir
1782 gdb_load "$exe"
1783 gdb_run_cmd
1784 gdb_expect {
1785 -re ".*Illegal instruction.*${gdb_prompt} $" {
1786 verbose -log "\n$me VSX hardware not detected"
1787 set skip_vsx_tests_saved 1
1788 }
fda326dd 1789 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
604c2f83
LM
1790 verbose -log "\n$me: VSX hardware detected"
1791 set skip_vsx_tests_saved 0
1792 }
1793 default {
1794 warning "\n$me: default case taken"
1795 set skip_vsx_tests_saved 1
1796 }
1797 }
1798 gdb_exit
1799 remote_file build delete $exe
1800
1801 verbose "$me: returning $skip_vsx_tests_saved" 2
1802 return $skip_vsx_tests_saved
1803}
1804
7a292a7a
SS
1805# Skip all the tests in the file if you are not on an hppa running
1806# hpux target.
1807
1808proc skip_hp_tests {} {
1809 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
c906108c
SS
1810 verbose "Skip hp tests is $skip_hp"
1811 return $skip_hp
1812}
1813
edb3359d
DJ
1814# Return whether we should skip tests for showing inlined functions in
1815# backtraces. Requires get_compiler_info and get_debug_format.
1816
1817proc skip_inline_frame_tests {} {
1818 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
1819 if { ! [test_debug_format "DWARF 2"] } {
1820 return 1
1821 }
1822
1823 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
1824 if { ([test_compiler_info "gcc-2-*"]
1825 || [test_compiler_info "gcc-3-*"]
1826 || [test_compiler_info "gcc-4-0-*"]) } {
1827 return 1
1828 }
1829
1830 return 0
1831}
1832
1833# Return whether we should skip tests for showing variables from
1834# inlined functions. Requires get_compiler_info and get_debug_format.
1835
1836proc skip_inline_var_tests {} {
1837 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
1838 if { ! [test_debug_format "DWARF 2"] } {
1839 return 1
1840 }
1841
1842 return 0
1843}
1844
b800ec70
UW
1845# Return a 1 if we should skip tests that require hardware breakpoints
1846
1847proc skip_hw_breakpoint_tests {} {
1848 # Skip tests if requested by the board (note that no_hardware_watchpoints
1849 # disables both watchpoints and breakpoints)
1850 if { [target_info exists gdb,no_hardware_watchpoints]} {
1851 return 1
1852 }
1853
1854 # These targets support hardware breakpoints natively
1855 if { [istarget "i?86-*-*"]
1856 || [istarget "x86_64-*-*"]
e3039479
UW
1857 || [istarget "ia64-*-*"]
1858 || [istarget "arm*-*-*"]} {
b800ec70
UW
1859 return 0
1860 }
1861
1862 return 1
1863}
1864
1865# Return a 1 if we should skip tests that require hardware watchpoints
1866
1867proc skip_hw_watchpoint_tests {} {
1868 # Skip tests if requested by the board
1869 if { [target_info exists gdb,no_hardware_watchpoints]} {
1870 return 1
1871 }
1872
1873 # These targets support hardware watchpoints natively
1874 if { [istarget "i?86-*-*"]
1875 || [istarget "x86_64-*-*"]
1876 || [istarget "ia64-*-*"]
e3039479 1877 || [istarget "arm*-*-*"]
b800ec70
UW
1878 || [istarget "powerpc*-*-linux*"]
1879 || [istarget "s390*-*-*"] } {
1880 return 0
1881 }
1882
1883 return 1
1884}
1885
1886# Return a 1 if we should skip tests that require *multiple* hardware
1887# watchpoints to be active at the same time
1888
1889proc skip_hw_watchpoint_multi_tests {} {
1890 if { [skip_hw_watchpoint_tests] } {
1891 return 1
1892 }
1893
1894 # These targets support just a single hardware watchpoint
e3039479
UW
1895 if { [istarget "arm*-*-*"]
1896 || [istarget "powerpc*-*-linux*"] } {
b800ec70
UW
1897 return 1
1898 }
1899
1900 return 0
1901}
1902
1903# Return a 1 if we should skip tests that require read/access watchpoints
1904
1905proc skip_hw_watchpoint_access_tests {} {
1906 if { [skip_hw_watchpoint_tests] } {
1907 return 1
1908 }
1909
1910 # These targets support just write watchpoints
1911 if { [istarget "s390*-*-*"] } {
1912 return 1
1913 }
1914
1915 return 0
1916}
1917
94b8e876
MC
1918set compiler_info "unknown"
1919set gcc_compiled 0
1920set hp_cc_compiler 0
1921set hp_aCC_compiler 0
94b8e876
MC
1922
1923# Figure out what compiler I am using.
1924#
1925# BINFILE is a "compiler information" output file. This implementation
1926# does not use BINFILE.
1927#
1928# ARGS can be empty or "C++". If empty, "C" is assumed.
1929#
1930# There are several ways to do this, with various problems.
1931#
1932# [ gdb_compile -E $ifile -o $binfile.ci ]
1933# source $binfile.ci
1934#
1935# Single Unix Spec v3 says that "-E -o ..." together are not
1936# specified. And in fact, the native compiler on hp-ux 11 (among
1937# others) does not work with "-E -o ...". Most targets used to do
1938# this, and it mostly worked, because it works with gcc.
1939#
1940# [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
1941# source $binfile.ci
1942#
1943# This avoids the problem with -E and -o together. This almost works
1944# if the build machine is the same as the host machine, which is
1945# usually true of the targets which are not gcc. But this code does
1946# not figure which compiler to call, and it always ends up using the C
1947# compiler. Not good for setting hp_aCC_compiler. Targets
1948# hppa*-*-hpux* and mips*-*-irix* used to do this.
1949#
1950# [ gdb_compile -E $ifile > $binfile.ci ]
1951# source $binfile.ci
1952#
1953# dejagnu target_compile says that it supports output redirection,
1954# but the code is completely different from the normal path and I
1955# don't want to sweep the mines from that path. So I didn't even try
1956# this.
1957#
1958# set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
1959# eval $cppout
1960#
1961# I actually do this for all targets now. gdb_compile runs the right
1962# compiler, and TCL captures the output, and I eval the output.
1963#
1964# Unfortunately, expect logs the output of the command as it goes by,
1965# and dejagnu helpfully prints a second copy of it right afterwards.
1966# So I turn off expect logging for a moment.
1967#
1968# [ gdb_compile $ifile $ciexe_file executable $args ]
1969# [ remote_exec $ciexe_file ]
1970# [ source $ci_file.out ]
1971#
1972# I could give up on -E and just do this.
1973# I didn't get desperate enough to try this.
1974#
1975# -- chastain 2004-01-06
853d6e5b 1976
c906108c 1977proc get_compiler_info {binfile args} {
94b8e876 1978 # For compiler.c and compiler.cc
c906108c 1979 global srcdir
94b8e876
MC
1980
1981 # I am going to play with the log to keep noise out.
1982 global outdir
1983 global tool
1984
1985 # These come from compiler.c or compiler.cc
853d6e5b 1986 global compiler_info
4f70a4c9
MC
1987
1988 # Legacy global data symbols.
94b8e876
MC
1989 global gcc_compiled
1990 global hp_cc_compiler
1991 global hp_aCC_compiler
c906108c 1992
94b8e876
MC
1993 # Choose which file to preprocess.
1994 set ifile "${srcdir}/lib/compiler.c"
1995 if { [llength $args] > 0 && [lindex $args 0] == "c++" } {
1996 set ifile "${srcdir}/lib/compiler.cc"
c906108c 1997 }
085dd6e6 1998
94b8e876
MC
1999 # Run $ifile through the right preprocessor.
2000 # Toggle gdb.log to keep the compiler output out of the log.
2001 log_file
e7f86de9
JM
2002 if [is_remote host] {
2003 # We have to use -E and -o together, despite the comments
2004 # above, because of how DejaGnu handles remote host testing.
2005 set ppout "$outdir/compiler.i"
2006 gdb_compile "${ifile}" "$ppout" preprocess [list "$args" quiet]
2007 set file [open $ppout r]
2008 set cppout [read $file]
2009 close $file
2010 } else {
2011 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$args" quiet] ]
2012 }
94b8e876
MC
2013 log_file -a "$outdir/$tool.log"
2014
4f70a4c9
MC
2015 # Eval the output.
2016 set unknown 0
94b8e876 2017 foreach cppline [ split "$cppout" "\n" ] {
4f70a4c9
MC
2018 if { [ regexp "^#" "$cppline" ] } {
2019 # line marker
2020 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
2021 # blank line
2022 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
2023 # eval this line
2024 verbose "get_compiler_info: $cppline" 2
2025 eval "$cppline"
2026 } else {
2027 # unknown line
2028 verbose -log "get_compiler_info: $cppline"
2029 set unknown 1
94b8e876 2030 }
085dd6e6 2031 }
4f70a4c9
MC
2032
2033 # Reset to unknown compiler if any diagnostics happened.
2034 if { $unknown } {
2035 set compiler_info "unknown"
4f70a4c9
MC
2036 }
2037
2038 # Set the legacy symbols.
2039 set gcc_compiled 0
2040 set hp_cc_compiler 0
2041 set hp_aCC_compiler 0
2042 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
2043 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
2044 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
2045 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
2046 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
2047 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
2048 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
2049
2050 # Log what happened.
94b8e876 2051 verbose -log "get_compiler_info: $compiler_info"
085dd6e6
JM
2052
2053 # Most compilers will evaluate comparisons and other boolean
2054 # operations to 0 or 1.
2055 uplevel \#0 { set true 1 }
2056 uplevel \#0 { set false 0 }
2057
94b8e876
MC
2058 # Use of aCC results in boolean results being displayed as
2059 # "true" or "false"
2060 if { $hp_aCC_compiler } {
2061 uplevel \#0 { set true true }
2062 uplevel \#0 { set false false }
085dd6e6
JM
2063 }
2064
c906108c
SS
2065 return 0;
2066}
2067
9b593790 2068proc test_compiler_info { {compiler ""} } {
853d6e5b 2069 global compiler_info
6e87504d
PG
2070
2071 # if no arg, return the compiler_info string
2072
2073 if [string match "" $compiler] {
2074 if [info exists compiler_info] {
2075 return $compiler_info
2076 } else {
2077 perror "No compiler info found."
2078 }
2079 }
2080
853d6e5b
AC
2081 return [string match $compiler $compiler_info]
2082}
2083
f6838f81
DJ
2084proc current_target_name { } {
2085 global target_info
2086 if [info exists target_info(target,name)] {
2087 set answer $target_info(target,name)
2088 } else {
2089 set answer ""
2090 }
2091 return $answer
2092}
2093
f1c47eb2 2094set gdb_wrapper_initialized 0
f6838f81 2095set gdb_wrapper_target ""
f1c47eb2
MS
2096
2097proc gdb_wrapper_init { args } {
2098 global gdb_wrapper_initialized;
2099 global gdb_wrapper_file;
2100 global gdb_wrapper_flags;
f6838f81 2101 global gdb_wrapper_target
f1c47eb2
MS
2102
2103 if { $gdb_wrapper_initialized == 1 } { return; }
2104
2105 if {[target_info exists needs_status_wrapper] && \
277254ba 2106 [target_info needs_status_wrapper] != "0"} {
f1c47eb2
MS
2107 set result [build_wrapper "testglue.o"];
2108 if { $result != "" } {
2109 set gdb_wrapper_file [lindex $result 0];
2110 set gdb_wrapper_flags [lindex $result 1];
2111 } else {
2112 warning "Status wrapper failed to build."
2113 }
2114 }
2115 set gdb_wrapper_initialized 1
f6838f81 2116 set gdb_wrapper_target [current_target_name]
f1c47eb2
MS
2117}
2118
f747e0ce
PA
2119# Some targets need to always link a special object in. Save its path here.
2120global gdb_saved_set_unbuffered_mode_obj
2121set gdb_saved_set_unbuffered_mode_obj ""
2122
c906108c
SS
2123proc gdb_compile {source dest type options} {
2124 global GDB_TESTCASE_OPTIONS;
f1c47eb2
MS
2125 global gdb_wrapper_file;
2126 global gdb_wrapper_flags;
2127 global gdb_wrapper_initialized;
f747e0ce
PA
2128 global srcdir
2129 global objdir
2130 global gdb_saved_set_unbuffered_mode_obj
c906108c 2131
695e2681
MK
2132 set outdir [file dirname $dest]
2133
2134 # Add platform-specific options if a shared library was specified using
2135 # "shlib=librarypath" in OPTIONS.
2136 set new_options ""
2137 set shlib_found 0
bdf7534a 2138 set shlib_load 0
695e2681 2139 foreach opt $options {
57bf0e56
DJ
2140 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
2141 if [test_compiler_info "xlc-*"] {
93f02886
DJ
2142 # IBM xlc compiler doesn't accept shared library named other
2143 # than .so: use "-Wl," to bypass this
2144 lappend source "-Wl,$shlib_name"
2145 } elseif { ([istarget "*-*-mingw*"]
2146 || [istarget *-*-cygwin*]
2147 || [istarget *-*-pe*])} {
2148 lappend source "${shlib_name}.a"
57bf0e56
DJ
2149 } else {
2150 lappend source $shlib_name
2151 }
0413d738 2152 if { $shlib_found == 0 } {
57bf0e56 2153 set shlib_found 1
0413d738
PA
2154 if { ([istarget "*-*-mingw*"]
2155 || [istarget *-*-cygwin*]) } {
bb61102d 2156 lappend new_options "additional_flags=-Wl,--enable-auto-import"
0413d738 2157 }
57bf0e56 2158 }
b0f4b84b 2159 } elseif { $opt == "shlib_load" } {
bdf7534a 2160 set shlib_load 1
57bf0e56
DJ
2161 } else {
2162 lappend new_options $opt
2163 }
695e2681 2164 }
bdf7534a
NF
2165
2166 # We typically link to shared libraries using an absolute path, and
2167 # that's how they are found at runtime. If we are going to
2168 # dynamically load one by basename, we must specify rpath. If we
2169 # are using a remote host, DejaGNU will link to the shared library
2170 # using a relative path, so again we must specify an rpath.
31f83dc5 2171 if { $shlib_load || ($shlib_found && [is_remote target]) } {
bdf7534a
NF
2172 if { ([istarget "*-*-mingw*"]
2173 || [istarget *-*-cygwin*]
2174 || [istarget *-*-pe*]
bdf7534a
NF
2175 || [istarget hppa*-*-hpux*])} {
2176 # Do not need anything.
2177 } elseif { [istarget *-*-openbsd*] } {
d8b34041 2178 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
759f0f0b
PA
2179 } elseif { [istarget arm*-*-symbianelf*] } {
2180 if { $shlib_load } {
2181 lappend new_options "libs=-ldl"
2182 }
bdf7534a
NF
2183 } else {
2184 if { $shlib_load } {
2185 lappend new_options "libs=-ldl"
2186 }
d8b34041 2187 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
bdf7534a
NF
2188 }
2189 }
695e2681 2190 set options $new_options
57bf0e56 2191
c906108c
SS
2192 if [target_info exists gdb_stub] {
2193 set options2 { "additional_flags=-Dusestubs" }
2194 lappend options "libs=[target_info gdb_stub]";
2195 set options [concat $options2 $options]
2196 }
2197 if [target_info exists is_vxworks] {
2198 set options2 { "additional_flags=-Dvxworks" }
2199 lappend options "libs=[target_info gdb_stub]";
2200 set options [concat $options2 $options]
2201 }
2202 if [info exists GDB_TESTCASE_OPTIONS] {
2203 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
2204 }
2205 verbose "options are $options"
2206 verbose "source is $source $dest $type $options"
2207
f1c47eb2
MS
2208 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
2209
2210 if {[target_info exists needs_status_wrapper] && \
2211 [target_info needs_status_wrapper] != "0" && \
2212 [info exists gdb_wrapper_file]} {
2213 lappend options "libs=${gdb_wrapper_file}"
2214 lappend options "ldflags=${gdb_wrapper_flags}"
2215 }
2216
fc91c6c2
PB
2217 # Replace the "nowarnings" option with the appropriate additional_flags
2218 # to disable compiler warnings.
2219 set nowarnings [lsearch -exact $options nowarnings]
2220 if {$nowarnings != -1} {
2221 if [target_info exists gdb,nowarnings_flag] {
2222 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
2223 } else {
2224 set flag "additional_flags=-w"
2225 }
2226 set options [lreplace $options $nowarnings $nowarnings $flag]
2227 }
2228
f747e0ce
PA
2229 if { $type == "executable" } {
2230 if { ([istarget "*-*-mingw*"]
56643c5e 2231 || [istarget "*-*-*djgpp"]
f747e0ce
PA
2232 || [istarget "*-*-cygwin*"])} {
2233 # Force output to unbuffered mode, by linking in an object file
2234 # with a global contructor that calls setvbuf.
2235 #
2236 # Compile the special object seperatelly for two reasons:
2237 # 1) Insulate it from $options.
2238 # 2) Avoid compiling it for every gdb_compile invocation,
2239 # which is time consuming, especially if we're remote
2240 # host testing.
2241 #
2242 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
2243 verbose "compiling gdb_saved_set_unbuffered_obj"
2244 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
2245 set unbuf_obj ${objdir}/set_unbuffered_mode.o
2246
2247 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
2248 if { $result != "" } {
2249 return $result
2250 }
2251
2252 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
2253 # Link a copy of the output object, because the
2254 # original may be automatically deleted.
2255 remote_exec host "cp -f $unbuf_obj $gdb_saved_set_unbuffered_mode_obj"
2256 } else {
2257 verbose "gdb_saved_set_unbuffered_obj already compiled"
2258 }
2259
2260 # Rely on the internal knowledge that the global ctors are ran in
2261 # reverse link order. In that case, we can use ldflags to
2262 # avoid copying the object file to the host multiple
2263 # times.
ace5c364
PM
2264 # This object can only be added if standard libraries are
2265 # used. Thus, we need to disable it if -nostdlib option is used
2266 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
2267 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
2268 }
f747e0ce
PA
2269 }
2270 }
2271
c906108c 2272 set result [target_compile $source $dest $type $options];
93f02886
DJ
2273
2274 # Prune uninteresting compiler (and linker) output.
2275 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
2276
c906108c
SS
2277 regsub "\[\r\n\]*$" "$result" "" result;
2278 regsub "^\[\r\n\]*" "$result" "" result;
ec3c07fc
NS
2279
2280 if {[lsearch $options quiet] < 0} {
2281 # We shall update this on a per language basis, to avoid
2282 # changing the entire testsuite in one go.
2283 if {[lsearch $options f77] >= 0} {
2284 gdb_compile_test $source $result
2285 } elseif { $result != "" } {
2286 clone_output "gdb compile failed, $result"
2287 }
c906108c
SS
2288 }
2289 return $result;
2290}
2291
b6ff0e81
JB
2292
2293# This is just like gdb_compile, above, except that it tries compiling
2294# against several different thread libraries, to see which one this
2295# system has.
2296proc gdb_compile_pthreads {source dest type options} {
0ae67eb3 2297 set built_binfile 0
b6ff0e81 2298 set why_msg "unrecognized error"
24486cb7 2299 foreach lib {-lpthreads -lpthread -lthread ""} {
b6ff0e81
JB
2300 # This kind of wipes out whatever libs the caller may have
2301 # set. Or maybe theirs will override ours. How infelicitous.
b5ab8ff3 2302 set options_with_lib [concat $options [list libs=$lib quiet]]
b6ff0e81
JB
2303 set ccout [gdb_compile $source $dest $type $options_with_lib]
2304 switch -regexp -- $ccout {
2305 ".*no posix threads support.*" {
2306 set why_msg "missing threads include file"
2307 break
2308 }
2309 ".*cannot open -lpthread.*" {
2310 set why_msg "missing runtime threads library"
2311 }
2312 ".*Can't find library for -lpthread.*" {
2313 set why_msg "missing runtime threads library"
2314 }
2315 {^$} {
2316 pass "successfully compiled posix threads test case"
2317 set built_binfile 1
2318 break
2319 }
2320 }
2321 }
0ae67eb3 2322 if {!$built_binfile} {
b6ff0e81
JB
2323 unsupported "Couldn't compile $source: ${why_msg}"
2324 return -1
2325 }
57bf0e56
DJ
2326}
2327
2328# Build a shared library from SOURCES. You must use get_compiler_info
2329# first.
2330
2331proc gdb_compile_shlib {sources dest options} {
2332 set obj_options $options
2333
2334 switch -glob [test_compiler_info] {
2335 "xlc-*" {
2336 lappend obj_options "additional_flags=-qpic"
2337 }
2338 "gcc-*" {
2339 if { !([istarget "powerpc*-*-aix*"]
227c54da
DJ
2340 || [istarget "rs6000*-*-aix*"]
2341 || [istarget "*-*-cygwin*"]
2342 || [istarget "*-*-mingw*"]
2343 || [istarget "*-*-pe*"]) } {
57bf0e56
DJ
2344 lappend obj_options "additional_flags=-fpic"
2345 }
2346 }
2347 default {
2348 switch -glob [istarget] {
2349 "hppa*-hp-hpux*" {
2350 lappend obj_options "additional_flags=+z"
2351 }
2352 "mips-sgi-irix*" {
2353 # Disable SGI compiler's implicit -Dsgi
2354 lappend obj_options "additional_flags=-Usgi"
2355 }
2356 default {
2357 # don't know what the compiler is...
2358 }
2359 }
2360 }
2361 }
2362
2363 set outdir [file dirname $dest]
2364 set objects ""
2365 foreach source $sources {
2366 set sourcebase [file tail $source]
2367 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
2368 return -1
2369 }
2370 lappend objects ${outdir}/${sourcebase}.o
2371 }
2372
2373 if [istarget "hppa*-*-hpux*"] {
2374 remote_exec build "ld -b ${objects} -o ${dest}"
2375 } else {
2376 set link_options $options
2377 if [test_compiler_info "xlc-*"] {
2378 lappend link_options "additional_flags=-qmkshrobj"
2379 } else {
2380 lappend link_options "additional_flags=-shared"
93f02886
DJ
2381
2382 if { ([istarget "*-*-mingw*"]
2383 || [istarget *-*-cygwin*]
2384 || [istarget *-*-pe*])} {
2385 lappend link_options "additional_flags=-Wl,--out-implib,${dest}.a"
31f83dc5
UW
2386 } elseif [is_remote target] {
2387 # By default, we do not set the soname. This causes the linker
2388 # on ELF systems to create a DT_NEEDED entry in the executable
2389 # refering to the full path name of the library. This is a
2390 # problem in remote testing if the library is in a different
2391 # directory there. To fix this, we set a soname of just the
2392 # base filename for the library, and add an appropriate -rpath
2393 # to the main executable (in gdb_compile).
2394 set destbase [file tail $dest]
2395 lappend link_options "additional_flags=-Wl,-soname,$destbase"
2396 }
57bf0e56
DJ
2397 }
2398 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
2399 return -1
2400 }
2401 }
b6ff0e81
JB
2402}
2403
756d88a7
UW
2404# This is just like gdb_compile_shlib, above, except that it tries compiling
2405# against several different thread libraries, to see which one this
2406# system has.
2407proc gdb_compile_shlib_pthreads {sources dest options} {
2408 set built_binfile 0
2409 set why_msg "unrecognized error"
2410 foreach lib {-lpthreads -lpthread -lthread ""} {
2411 # This kind of wipes out whatever libs the caller may have
2412 # set. Or maybe theirs will override ours. How infelicitous.
2413 set options_with_lib [concat $options [list libs=$lib quiet]]
2414 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
2415 switch -regexp -- $ccout {
2416 ".*no posix threads support.*" {
2417 set why_msg "missing threads include file"
2418 break
2419 }
2420 ".*cannot open -lpthread.*" {
2421 set why_msg "missing runtime threads library"
2422 }
2423 ".*Can't find library for -lpthread.*" {
2424 set why_msg "missing runtime threads library"
2425 }
2426 {^$} {
2427 pass "successfully compiled posix threads test case"
2428 set built_binfile 1
2429 break
2430 }
2431 }
2432 }
2433 if {!$built_binfile} {
2434 unsupported "Couldn't compile $sources: ${why_msg}"
2435 return -1
2436 }
2437}
2438
130cacce
AF
2439# This is just like gdb_compile_pthreads, above, except that we always add the
2440# objc library for compiling Objective-C programs
2441proc gdb_compile_objc {source dest type options} {
2442 set built_binfile 0
2443 set why_msg "unrecognized error"
2444 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
2445 # This kind of wipes out whatever libs the caller may have
2446 # set. Or maybe theirs will override ours. How infelicitous.
2447 if { $lib == "solaris" } {
2448 set lib "-lpthread -lposix4"
2449 }
2450 if { $lib != "-lobjc" } {
2451 set lib "-lobjc $lib"
2452 }
2453 set options_with_lib [concat $options [list libs=$lib quiet]]
2454 set ccout [gdb_compile $source $dest $type $options_with_lib]
2455 switch -regexp -- $ccout {
2456 ".*no posix threads support.*" {
2457 set why_msg "missing threads include file"
2458 break
2459 }
2460 ".*cannot open -lpthread.*" {
2461 set why_msg "missing runtime threads library"
2462 }
2463 ".*Can't find library for -lpthread.*" {
2464 set why_msg "missing runtime threads library"
2465 }
2466 {^$} {
2467 pass "successfully compiled objc with posix threads test case"
2468 set built_binfile 1
2469 break
2470 }
2471 }
2472 }
2473 if {!$built_binfile} {
2474 unsupported "Couldn't compile $source: ${why_msg}"
2475 return -1
2476 }
2477}
2478
c906108c
SS
2479proc send_gdb { string } {
2480 global suppress_flag;
2481 if { $suppress_flag } {
2482 return "suppressed";
2483 }
2484 return [remote_send host "$string"];
2485}
2486
2487#
2488#
2489
2490proc gdb_expect { args } {
2491 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
2f34202f 2492 set atimeout [lindex $args 0];
c906108c
SS
2493 set expcode [list [lindex $args 1]];
2494 } else {
c906108c 2495 set expcode $args;
2f34202f
MR
2496 }
2497
2498 upvar timeout timeout;
2499
2500 if [target_info exists gdb,timeout] {
2501 if [info exists timeout] {
2502 if { $timeout < [target_info gdb,timeout] } {
c906108c 2503 set gtimeout [target_info gdb,timeout];
2f34202f
MR
2504 } else {
2505 set gtimeout $timeout;
c906108c 2506 }
2f34202f
MR
2507 } else {
2508 set gtimeout [target_info gdb,timeout];
c906108c 2509 }
2f34202f 2510 }
c906108c 2511
2f34202f
MR
2512 if ![info exists gtimeout] {
2513 global timeout;
2514 if [info exists timeout] {
2515 set gtimeout $timeout;
2516 }
2517 }
2518
2519 if [info exists atimeout] {
2520 if { ![info exists gtimeout] || $gtimeout < $atimeout } {
db16b772 2521 set gtimeout $atimeout;
2f34202f
MR
2522 }
2523 } else {
c906108c 2524 if ![info exists gtimeout] {
2f34202f
MR
2525 # Eeeeew.
2526 set gtimeout 60;
c906108c
SS
2527 }
2528 }
2f34202f 2529
c906108c
SS
2530 global suppress_flag;
2531 global remote_suppress_flag;
2532 if [info exists remote_suppress_flag] {
2533 set old_val $remote_suppress_flag;
2534 }
2535 if [info exists suppress_flag] {
2536 if { $suppress_flag } {
2537 set remote_suppress_flag 1;
2538 }
2539 }
a0b3c4fd 2540 set code [catch \
5f279fa6 2541 {uplevel remote_expect host $gtimeout $expcode} string];
c906108c
SS
2542 if [info exists old_val] {
2543 set remote_suppress_flag $old_val;
2544 } else {
2545 if [info exists remote_suppress_flag] {
2546 unset remote_suppress_flag;
2547 }
2548 }
2549
2550 if {$code == 1} {
2551 global errorInfo errorCode;
2552
2553 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
2554 } elseif {$code == 2} {
2555 return -code return $string
2556 } elseif {$code == 3} {
2557 return
2558 } elseif {$code > 4} {
2559 return -code $code $string
2560 }
2561}
2562
5fa290c1 2563# gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
085dd6e6
JM
2564#
2565# Check for long sequence of output by parts.
5fa290c1 2566# TEST: is the test message to be printed with the test success/fail.
085dd6e6
JM
2567# SENTINEL: Is the terminal pattern indicating that output has finished.
2568# LIST: is the sequence of outputs to match.
2569# If the sentinel is recognized early, it is considered an error.
2570#
11cf8741
JM
2571# Returns:
2572# 1 if the test failed,
2573# 0 if the test passes,
2574# -1 if there was an internal error.
5fa290c1 2575
c2d11a7d 2576proc gdb_expect_list {test sentinel list} {
085dd6e6 2577 global gdb_prompt
11cf8741 2578 global suppress_flag
085dd6e6 2579 set index 0
43ff13b4 2580 set ok 1
11cf8741
JM
2581 if { $suppress_flag } {
2582 set ok 0
a20ce2c3 2583 unresolved "${test}"
11cf8741 2584 }
43ff13b4 2585 while { ${index} < [llength ${list}] } {
085dd6e6
JM
2586 set pattern [lindex ${list} ${index}]
2587 set index [expr ${index} + 1]
6b0ecdc2 2588 verbose -log "gdb_expect_list pattern: /$pattern/" 2
085dd6e6 2589 if { ${index} == [llength ${list}] } {
43ff13b4
JM
2590 if { ${ok} } {
2591 gdb_expect {
c2d11a7d 2592 -re "${pattern}${sentinel}" {
a20ce2c3 2593 # pass "${test}, pattern ${index} + sentinel"
c2d11a7d
JM
2594 }
2595 -re "${sentinel}" {
a20ce2c3 2596 fail "${test} (pattern ${index} + sentinel)"
c2d11a7d 2597 set ok 0
43ff13b4 2598 }
5c5455dc
AC
2599 -re ".*A problem internal to GDB has been detected" {
2600 fail "${test} (GDB internal error)"
2601 set ok 0
2602 gdb_internal_error_resync
2603 }
43ff13b4 2604 timeout {
a20ce2c3 2605 fail "${test} (pattern ${index} + sentinel) (timeout)"
43ff13b4
JM
2606 set ok 0
2607 }
085dd6e6 2608 }
43ff13b4 2609 } else {
a20ce2c3 2610 # unresolved "${test}, pattern ${index} + sentinel"
085dd6e6
JM
2611 }
2612 } else {
43ff13b4
JM
2613 if { ${ok} } {
2614 gdb_expect {
2615 -re "${pattern}" {
a20ce2c3 2616 # pass "${test}, pattern ${index}"
43ff13b4 2617 }
c2d11a7d 2618 -re "${sentinel}" {
a20ce2c3 2619 fail "${test} (pattern ${index})"
43ff13b4
JM
2620 set ok 0
2621 }
5c5455dc
AC
2622 -re ".*A problem internal to GDB has been detected" {
2623 fail "${test} (GDB internal error)"
2624 set ok 0
2625 gdb_internal_error_resync
2626 }
43ff13b4 2627 timeout {
a20ce2c3 2628 fail "${test} (pattern ${index}) (timeout)"
43ff13b4
JM
2629 set ok 0
2630 }
085dd6e6 2631 }
43ff13b4 2632 } else {
a20ce2c3 2633 # unresolved "${test}, pattern ${index}"
085dd6e6
JM
2634 }
2635 }
2636 }
11cf8741 2637 if { ${ok} } {
a20ce2c3 2638 pass "${test}"
11cf8741
JM
2639 return 0
2640 } else {
2641 return 1
2642 }
085dd6e6
JM
2643}
2644
2645#
2646#
c906108c
SS
2647proc gdb_suppress_entire_file { reason } {
2648 global suppress_flag;
2649
2650 warning "$reason\n";
2651 set suppress_flag -1;
2652}
2653
2654#
2655# Set suppress_flag, which will cause all subsequent calls to send_gdb and
2656# gdb_expect to fail immediately (until the next call to
2657# gdb_stop_suppressing_tests).
2658#
2659proc gdb_suppress_tests { args } {
2660 global suppress_flag;
2661
2662 return; # fnf - disable pending review of results where
2663 # testsuite ran better without this
2664 incr suppress_flag;
2665
2666 if { $suppress_flag == 1 } {
2667 if { [llength $args] > 0 } {
2668 warning "[lindex $args 0]\n";
2669 } else {
2670 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
2671 }
2672 }
2673}
2674
2675#
2676# Clear suppress_flag.
2677#
2678proc gdb_stop_suppressing_tests { } {
2679 global suppress_flag;
2680
2681 if [info exists suppress_flag] {
2682 if { $suppress_flag > 0 } {
2683 set suppress_flag 0;
2684 clone_output "Tests restarted.\n";
2685 }
2686 } else {
2687 set suppress_flag 0;
2688 }
2689}
2690
2691proc gdb_clear_suppressed { } {
2692 global suppress_flag;
2693
2694 set suppress_flag 0;
2695}
2696
2697proc gdb_start { } {
2698 default_gdb_start
2699}
2700
2701proc gdb_exit { } {
2702 catch default_gdb_exit
2703}
2704
e63b55d1
NS
2705#
2706# gdb_load_cmd -- load a file into the debugger.
2707# ARGS - additional args to load command.
2708# return a -1 if anything goes wrong.
2709#
2710proc gdb_load_cmd { args } {
2711 global gdb_prompt
2712
2713 if [target_info exists gdb_load_timeout] {
2714 set loadtimeout [target_info gdb_load_timeout]
2715 } else {
2716 set loadtimeout 1600
2717 }
2718 send_gdb "load $args\n"
e91528f0 2719 verbose "Timeout is now $loadtimeout seconds" 2
e63b55d1
NS
2720 gdb_expect $loadtimeout {
2721 -re "Loading section\[^\r\]*\r\n" {
2722 exp_continue
2723 }
2724 -re "Start address\[\r\]*\r\n" {
2725 exp_continue
2726 }
2727 -re "Transfer rate\[\r\]*\r\n" {
2728 exp_continue
2729 }
2730 -re "Memory access error\[^\r\]*\r\n" {
2731 perror "Failed to load program"
2732 return -1
2733 }
2734 -re "$gdb_prompt $" {
2735 return 0
2736 }
2737 -re "(.*)\r\n$gdb_prompt " {
2738 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
2739 return -1
2740 }
2741 timeout {
c4b347c7 2742 perror "Timed out trying to load $args."
e63b55d1
NS
2743 return -1
2744 }
2745 }
2746 return -1
2747}
2748
759f0f0b
PA
2749# Return the filename to download to the target and load on the target
2750# for this shared library. Normally just LIBNAME, unless shared libraries
2751# for this target have separate link and load images.
2752
2753proc shlib_target_file { libname } {
2754 return $libname
2755}
2756
2757# Return the filename GDB will load symbols from when debugging this
2758# shared library. Normally just LIBNAME, unless shared libraries for
2759# this target have separate link and load images.
2760
2761proc shlib_symbol_file { libname } {
2762 return $libname
2763}
2764
56744f0a
JJ
2765# Return the filename to download to the target and load for this
2766# executable. Normally just BINFILE unless it is renamed to something
2767# else for this target.
2768
2769proc exec_target_file { binfile } {
2770 return $binfile
2771}
2772
2773# Return the filename GDB will load symbols from when debugging this
2774# executable. Normally just BINFILE unless executables for this target
2775# have separate files for symbols.
2776
2777proc exec_symbol_file { binfile } {
2778 return $binfile
2779}
2780
2781# Rename the executable file. Normally this is just BINFILE1 being renamed
2782# to BINFILE2, but some targets require multiple binary files.
2783proc gdb_rename_execfile { binfile1 binfile2 } {
faf067f1
JK
2784 file rename -force [exec_target_file ${binfile1}] \
2785 [exec_target_file ${binfile2}]
56744f0a 2786 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
faf067f1
JK
2787 file rename -force [exec_symbol_file ${binfile1}] \
2788 [exec_symbol_file ${binfile2}]
56744f0a
JJ
2789 }
2790}
2791
2792# "Touch" the executable file to update the date. Normally this is just
2793# BINFILE, but some targets require multiple files.
2794proc gdb_touch_execfile { binfile } {
faf067f1
JK
2795 set time [clock seconds]
2796 file mtime [exec_target_file ${binfile}] $time
56744f0a 2797 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
faf067f1 2798 file mtime [exec_symbol_file ${binfile}] $time
56744f0a
JJ
2799 }
2800}
2801
93f02886
DJ
2802# gdb_download
2803#
2804# Copy a file to the remote target and return its target filename.
2805# Schedule the file to be deleted at the end of this test.
2806
2807proc gdb_download { filename } {
2808 global cleanfiles
2809
2810 set destname [remote_download target $filename]
2811 lappend cleanfiles $destname
2812 return $destname
2813}
2814
2815# gdb_load_shlibs LIB...
2816#
2817# Copy the listed libraries to the target.
2818
2819proc gdb_load_shlibs { args } {
2820 if {![is_remote target]} {
2821 return
2822 }
2823
2824 foreach file $args {
759f0f0b 2825 gdb_download [shlib_target_file $file]
93f02886
DJ
2826 }
2827
2828 # Even if the target supplies full paths for shared libraries,
2829 # they may not be paths for this system.
2830 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
2831}
2832
c906108c
SS
2833#
2834# gdb_load -- load a file into the debugger.
2db8e78e 2835# Many files in config/*.exp override this procedure.
c906108c
SS
2836#
2837proc gdb_load { arg } {
2838 return [gdb_file_cmd $arg]
2839}
2840
b741e217
DJ
2841# gdb_reload -- load a file into the target. Called before "running",
2842# either the first time or after already starting the program once,
2843# for remote targets. Most files that override gdb_load should now
2844# override this instead.
2845
2846proc gdb_reload { } {
2847 # For the benefit of existing configurations, default to gdb_load.
2848 # Specifying no file defaults to the executable currently being
2849 # debugged.
2850 return [gdb_load ""]
2851}
2852
c906108c
SS
2853proc gdb_continue { function } {
2854 global decimal
2855
2856 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
2857}
2858
2859proc default_gdb_init { args } {
277254ba 2860 global gdb_wrapper_initialized
f6838f81 2861 global gdb_wrapper_target
93f02886 2862 global cleanfiles
277254ba 2863
93f02886
DJ
2864 set cleanfiles {}
2865
c906108c
SS
2866 gdb_clear_suppressed;
2867
277254ba
MS
2868 # Make sure that the wrapper is rebuilt
2869 # with the appropriate multilib option.
f6838f81
DJ
2870 if { $gdb_wrapper_target != [current_target_name] } {
2871 set gdb_wrapper_initialized 0
2872 }
277254ba 2873
7b433602
JB
2874 # Unlike most tests, we have a small number of tests that generate
2875 # a very large amount of output. We therefore increase the expect
2876 # buffer size to be able to contain the entire test output.
2877 match_max -d 30000
8d417781
PM
2878 # Also set this value for the currently running GDB.
2879 match_max [match_max -d]
c906108c
SS
2880
2881 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
2882 if { [llength $args] > 0 } {
2883 global pf_prefix
2884
2885 set file [lindex $args 0];
2886
2887 set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
2888 }
2889 global gdb_prompt;
2890 if [target_info exists gdb_prompt] {
2891 set gdb_prompt [target_info gdb_prompt];
2892 } else {
2893 set gdb_prompt "\\(gdb\\)"
2894 }
2895}
2896
7b356089
JB
2897# The default timeout used when testing GDB commands. We want to use
2898# the same timeout as the default dejagnu timeout, unless the user has
2899# already provided a specific value (probably through a site.exp file).
2900global gdb_test_timeout
2901if ![info exists gdb_test_timeout] {
2902 set gdb_test_timeout $timeout
2903}
2904
47050449
JB
2905# A list of global variables that GDB testcases should not use.
2906# We try to prevent their use by monitoring write accesses and raising
2907# an error when that happens.
2908set banned_variables { bug_id prms_id }
2909
41b2c92d
PM
2910# gdb_init is called by runtest at start, but also by several
2911# tests directly; gdb_finish is only called from within runtest after
2912# each test source execution.
2913# Placing several traces by repetitive calls to gdb_init leads
2914# to problems, as only one trace is removed in gdb_finish.
2915# To overcome this possible problem, we add a variable that records
2916# if the banned variables are traced.
2917set banned_variables_traced 0
2918
c906108c 2919proc gdb_init { args } {
7b356089
JB
2920 # Reset the timeout value to the default. This way, any testcase
2921 # that changes the timeout value without resetting it cannot affect
2922 # the timeout used in subsequent testcases.
2923 global gdb_test_timeout
2924 global timeout
2925 set timeout $gdb_test_timeout
2926
47050449
JB
2927 # Block writes to all banned variables...
2928 global banned_variables
41b2c92d
PM
2929 global banned_variables_traced
2930 if (!$banned_variables_traced) {
2931 foreach banned_var $banned_variables {
2932 global "$banned_var"
2933 trace add variable "$banned_var" write error
2934 }
2935 set banned_variables_traced 1
47050449
JB
2936 }
2937
e7ab5e63
AB
2938 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
2939 # messages as expected.
c6f2ac43 2940 setenv LC_ALL C
e7ab5e63 2941 setenv LC_CTYPE C
c6f2ac43
PA
2942 setenv LANG C
2943
e7ab5e63
AB
2944 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
2945 # the test results. Even if /dev/null doesn't exist on the particular
2946 # platform, the readline library will use the default setting just by
2947 # failing to open the file. OTOH, opening /dev/null successfully will
2948 # also result in the default settings being used since nothing will be
2949 # read from this file.
2950 setenv INPUTRC "/dev/null"
2951
2952 # The gdb.base/readline.exp arrow key test relies on the standard VT100
2953 # bindings, so make sure that an appropriate terminal is selected.
2954 # The same bug doesn't show up if we use ^P / ^N instead.
2955 setenv TERM "vt100"
2956
2957 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
2958 # grep. Clear GREP_OPTIONS to make the behavoiur predictable,
2959 # especially having color output turned on can cause tests to fail.
2960 setenv GREP_OPTIONS ""
2961
03f2bd59
JK
2962 # Clear $gdbserver_reconnect_p.
2963 global gdbserver_reconnect_p
2964 set gdbserver_reconnect_p 1
2965 unset gdbserver_reconnect_p
2966
c906108c
SS
2967 return [eval default_gdb_init $args];
2968}
2969
2970proc gdb_finish { } {
93f02886
DJ
2971 global cleanfiles
2972
2973 # Exit first, so that the files are no longer in use.
2974 gdb_exit
2975
2976 if { [llength $cleanfiles] > 0 } {
2977 eval remote_file target delete $cleanfiles
2978 set cleanfiles {}
2979 }
47050449
JB
2980
2981 # Unblock write access to the banned variables. Dejagnu typically
2982 # resets some of them between testcases.
2983 global banned_variables
41b2c92d
PM
2984 global banned_variables_traced
2985 if ($banned_variables_traced) {
2986 foreach banned_var $banned_variables {
2987 global "$banned_var"
2988 trace remove variable "$banned_var" write error
2989 }
2990 set banned_variables_traced 0
47050449 2991 }
c906108c
SS
2992}
2993
2994global debug_format
7a292a7a 2995set debug_format "unknown"
c906108c
SS
2996
2997# Run the gdb command "info source" and extract the debugging format
2998# information from the output and save it in debug_format.
2999
3000proc get_debug_format { } {
3001 global gdb_prompt
3002 global verbose
3003 global expect_out
3004 global debug_format
3005
3006 set debug_format "unknown"
3007 send_gdb "info source\n"
3008 gdb_expect 10 {
919d772c 3009 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
c906108c
SS
3010 set debug_format $expect_out(1,string)
3011 verbose "debug format is $debug_format"
3012 return 1;
3013 }
3014 -re "No current source file.\r\n$gdb_prompt $" {
3015 perror "get_debug_format used when no current source file"
3016 return 0;
3017 }
3018 -re "$gdb_prompt $" {
3019 warning "couldn't check debug format (no valid response)."
3020 return 1;
3021 }
3022 timeout {
3023 warning "couldn't check debug format (timed out)."
3024 return 1;
3025 }
3026 }
3027}
3028
838ae6c4
JB
3029# Return true if FORMAT matches the debug format the current test was
3030# compiled with. FORMAT is a shell-style globbing pattern; it can use
3031# `*', `[...]', and so on.
3032#
3033# This function depends on variables set by `get_debug_format', above.
3034
3035proc test_debug_format {format} {
3036 global debug_format
3037
3038 return [expr [string match $format $debug_format] != 0]
3039}
3040
c906108c
SS
3041# Like setup_xfail, but takes the name of a debug format (DWARF 1,
3042# COFF, stabs, etc). If that format matches the format that the
3043# current test was compiled with, then the next test is expected to
3044# fail for any target. Returns 1 if the next test or set of tests is
3045# expected to fail, 0 otherwise (or if it is unknown). Must have
3046# previously called get_debug_format.
b55a4771 3047proc setup_xfail_format { format } {
838ae6c4 3048 set ret [test_debug_format $format];
b55a4771 3049
838ae6c4 3050 if {$ret} then {
b55a4771
MS
3051 setup_xfail "*-*-*"
3052 }
3053 return $ret;
3054}
c906108c 3055
6680506e
YQ
3056# Like setup_kfail, but only call setup_kfail conditionally if
3057# istarget[TARGET] returns true.
3058proc setup_kfail_for_target { PR target } {
3059 if { [istarget $target] } {
3060 setup_kfail $PR $target
3061 }
3062}
3063
c906108c
SS
3064proc gdb_step_for_stub { } {
3065 global gdb_prompt;
3066
3067 if ![target_info exists gdb,use_breakpoint_for_stub] {
3068 if [target_info exists gdb_stub_step_command] {
3069 set command [target_info gdb_stub_step_command];
3070 } else {
3071 set command "step";
3072 }
3073 send_gdb "${command}\n";
3074 set tries 0;
3075 gdb_expect 60 {
3076 -re "(main.* at |.*in .*start).*$gdb_prompt" {
3077 return;
3078 }
3079 -re ".*$gdb_prompt" {
3080 incr tries;
3081 if { $tries == 5 } {
3082 fail "stepping out of breakpoint function";
3083 return;
3084 }
3085 send_gdb "${command}\n";
3086 exp_continue;
3087 }
3088 default {
3089 fail "stepping out of breakpoint function";
3090 return;
3091 }
3092 }
3093 }
3094 send_gdb "where\n";
3095 gdb_expect {
3096 -re "main\[^\r\n\]*at \(\[^:]+\):\(\[0-9\]+\)" {
3097 set file $expect_out(1,string);
3098 set linenum [expr $expect_out(2,string) + 1];
3099 set breakplace "${file}:${linenum}";
3100 }
3101 default {}
3102 }
3103 send_gdb "break ${breakplace}\n";
3104 gdb_expect 60 {
3105 -re "Breakpoint (\[0-9\]+) at.*$gdb_prompt" {
3106 set breakpoint $expect_out(1,string);
3107 }
3108 -re "Breakpoint (\[0-9\]+): file.*$gdb_prompt" {
3109 set breakpoint $expect_out(1,string);
3110 }
3111 default {}
3112 }
3113 send_gdb "continue\n";
3114 gdb_expect 60 {
3115 -re "Breakpoint ${breakpoint},.*$gdb_prompt" {
3116 gdb_test "delete $breakpoint" ".*" "";
3117 return;
3118 }
3119 default {}
3120 }
3121}
3122
c6fee705
MC
3123# gdb_get_line_number TEXT [FILE]
3124#
3125# Search the source file FILE, and return the line number of the
3126# first line containing TEXT. If no match is found, return -1.
3127#
3128# TEXT is a string literal, not a regular expression.
3129#
3130# The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
3131# specified, and does not start with "/", then it is assumed to be in
3132# "$srcdir/$subdir". This is awkward, and can be fixed in the future,
3133# by changing the callers and the interface at the same time.
3134# In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
3135# gdb.base/ena-dis-br.exp.
3136#
3137# Use this function to keep your test scripts independent of the
3138# exact line numbering of the source file. Don't write:
3139#
3140# send_gdb "break 20"
3141#
3142# This means that if anyone ever edits your test's source file,
3143# your test could break. Instead, put a comment like this on the
3144# source file line you want to break at:
3145#
3146# /* breakpoint spot: frotz.exp: test name */
3147#
3148# and then write, in your test script (which we assume is named
3149# frotz.exp):
3150#
3151# send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
3152#
3153# (Yes, Tcl knows how to handle the nested quotes and brackets.
3154# Try this:
3155# $ tclsh
3156# % puts "foo [lindex "bar baz" 1]"
3157# foo baz
3158# %
3159# Tcl is quite clever, for a little stringy language.)
3160#
3161# ===
3162#
3163# The previous implementation of this procedure used the gdb search command.
3164# This version is different:
3165#
3166# . It works with MI, and it also works when gdb is not running.
3167#
3168# . It operates on the build machine, not the host machine.
3169#
3170# . For now, this implementation fakes a current directory of
3171# $srcdir/$subdir to be compatible with the old implementation.
3172# This will go away eventually and some callers will need to
3173# be changed.
3174#
3175# . The TEXT argument is literal text and matches literally,
3176# not a regular expression as it was before.
3177#
3178# . State changes in gdb, such as changing the current file
3179# and setting $_, no longer happen.
3180#
3181# After a bit of time we can forget about the differences from the
3182# old implementation.
3183#
3184# --chastain 2004-08-05
3185
3186proc gdb_get_line_number { text { file "" } } {
3187 global srcdir
3188 global subdir
3189 global srcfile
c906108c 3190
c6fee705
MC
3191 if { "$file" == "" } then {
3192 set file "$srcfile"
3193 }
3194 if { ! [regexp "^/" "$file"] } then {
3195 set file "$srcdir/$subdir/$file"
c906108c
SS
3196 }
3197
c6fee705
MC
3198 if { [ catch { set fd [open "$file"] } message ] } then {
3199 perror "$message"
3200 return -1
c906108c 3201 }
c6fee705
MC
3202
3203 set found -1
3204 for { set line 1 } { 1 } { incr line } {
3205 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
3206 perror "$message"
3207 return -1
3208 }
3209 if { $nchar < 0 } then {
3210 break
3211 }
3212 if { [string first "$text" "$body"] >= 0 } then {
3213 set found $line
3214 break
3215 }
3216 }
3217
3218 if { [ catch { close "$fd" } message ] } then {
3219 perror "$message"
3220 return -1
3221 }
3222
3223 return $found
c906108c
SS
3224}
3225
7a292a7a
SS
3226# gdb_continue_to_end:
3227# The case where the target uses stubs has to be handled specially. If a
3228# stub is used, we set a breakpoint at exit because we cannot rely on
3229# exit() behavior of a remote target.
3230#
fda326dd
TT
3231# MSSG is the error message that gets printed. If not given, a
3232# default is used.
3233# COMMAND is the command to invoke. If not given, "continue" is
3234# used.
eceb0c5f
TT
3235# ALLOW_EXTRA is a flag indicating whether the test should expect
3236# extra output between the "Continuing." line and the program
3237# exiting. By default it is zero; if nonzero, any extra output
3238# is accepted.
fda326dd 3239
eceb0c5f 3240proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
fda326dd 3241 global inferior_exited_re
7a292a7a 3242
fda326dd
TT
3243 if {$mssg == ""} {
3244 set text "continue until exit"
3245 } else {
3246 set text "continue until exit at $mssg"
3247 }
eceb0c5f
TT
3248 if {$allow_extra} {
3249 set extra ".*"
3250 } else {
3251 set extra ""
3252 }
7a292a7a
SS
3253 if [target_info exists use_gdb_stub] {
3254 if {![gdb_breakpoint "exit"]} {
3255 return 0
3256 }
eceb0c5f 3257 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
fda326dd 3258 $text
7a292a7a
SS
3259 } else {
3260 # Continue until we exit. Should not stop again.
3261 # Don't bother to check the output of the program, that may be
3262 # extremely tough for some remote systems.
eceb0c5f
TT
3263 gdb_test $command \
3264 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
fda326dd 3265 $text
7a292a7a
SS
3266 }
3267}
3268
3269proc rerun_to_main {} {
3270 global gdb_prompt
3271
3272 if [target_info exists use_gdb_stub] {
3273 gdb_run_cmd
3274 gdb_expect {
3275 -re ".*Breakpoint .*main .*$gdb_prompt $"\
3276 {pass "rerun to main" ; return 0}
3277 -re "$gdb_prompt $"\
3278 {fail "rerun to main" ; return 0}
3279 timeout {fail "(timeout) rerun to main" ; return 0}
3280 }
3281 } else {
3282 send_gdb "run\n"
3283 gdb_expect {
11350d2a
CV
3284 -re "The program .* has been started already.*y or n. $" {
3285 send_gdb "y\n"
3286 exp_continue
3287 }
7a292a7a
SS
3288 -re "Starting program.*$gdb_prompt $"\
3289 {pass "rerun to main" ; return 0}
3290 -re "$gdb_prompt $"\
3291 {fail "rerun to main" ; return 0}
3292 timeout {fail "(timeout) rerun to main" ; return 0}
3293 }
3294 }
3295}
c906108c 3296
13a5e3b8
MS
3297# Print a message and return true if a test should be skipped
3298# due to lack of floating point suport.
3299
3300proc gdb_skip_float_test { msg } {
3301 if [target_info exists gdb,skip_float_tests] {
3302 verbose "Skipping test '$msg': no float tests.";
3303 return 1;
3304 }
3305 return 0;
3306}
3307
3308# Print a message and return true if a test should be skipped
3309# due to lack of stdio support.
3310
3311proc gdb_skip_stdio_test { msg } {
3312 if [target_info exists gdb,noinferiorio] {
3313 verbose "Skipping test '$msg': no inferior i/o.";
3314 return 1;
3315 }
3316 return 0;
3317}
3318
3319proc gdb_skip_bogus_test { msg } {
3320 return 0;
3321}
3322
e515b470
DJ
3323# Return true if a test should be skipped due to lack of XML support
3324# in the host GDB.
d0ef5df8 3325# NOTE: This must be called while gdb is *not* running.
e515b470
DJ
3326
3327proc gdb_skip_xml_test { } {
3328 global gdb_prompt
3329 global srcdir
3330 global xml_missing_cached
3331
3332 if {[info exists xml_missing_cached]} {
3333 return $xml_missing_cached
3334 }
3335
3336 gdb_start
3337 set xml_missing_cached 0
3338 gdb_test_multiple "set tdesc filename ${srcdir}/gdb.xml/trivial.xml" "" {
3339 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
3340 set xml_missing_cached 1
3341 }
3342 -re ".*$gdb_prompt $" { }
3343 }
3344 gdb_exit
3345 return $xml_missing_cached
3346}
1f8a6abb
EZ
3347
3348# Note: the procedure gdb_gnu_strip_debug will produce an executable called
3349# ${binfile}.dbglnk, which is just like the executable ($binfile) but without
3350# the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
8e1d0c49
JK
3351# the name of a debuginfo only file. This file will be stored in the same
3352# subdirectory.
1f8a6abb
EZ
3353
3354# Functions for separate debug info testing
3355
3356# starting with an executable:
3357# foo --> original executable
3358
3359# at the end of the process we have:
3360# foo.stripped --> foo w/o debug info
8e1d0c49 3361# foo.debug --> foo's debug info
1f8a6abb
EZ
3362# foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
3363
4935890f
JK
3364# Return the build-id hex string (usually 160 bits as 40 hex characters)
3365# converted to the form: .build-id/ab/cdef1234...89.debug
3366# Return "" if no build-id found.
3367proc build_id_debug_filename_get { exec } {
3368 set tmp "${exec}-tmp"
8b3fc8d8
MK
3369 set objcopy_program [transform objcopy]
3370
3371 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $exec $tmp" output]
3372 verbose "result is $result"
3373 verbose "output is $output"
3374 if {$result == 1} {
3375 return ""
3376 }
4935890f 3377 set fi [open $tmp]
b7fca990 3378 fconfigure $fi -translation binary
4935890f
JK
3379 # Skip the NOTE header.
3380 read $fi 16
3381 set data [read $fi]
3382 close $fi
3383 file delete $tmp
7020f05c 3384 if ![string compare $data ""] then {
4935890f
JK
3385 return ""
3386 }
3387 # Convert it to hex.
3388 binary scan $data H* data
061b5285 3389 regsub {^..} $data {\0/} data
4935890f
JK
3390 return ".build-id/${data}.debug";
3391}
3392
94277a38
DJ
3393# Create stripped files for DEST, replacing it. If ARGS is passed, it is a
3394# list of optional flags. The only currently supported flag is no-main,
3395# which removes the symbol entry for main from the separate debug file.
c0201579
JK
3396#
3397# Function returns zero on success. Function will return non-zero failure code
3398# on some targets not supporting separate debug info (such as i386-msdos).
1f8a6abb 3399
94277a38
DJ
3400proc gdb_gnu_strip_debug { dest args } {
3401
8e1d0c49
JK
3402 # Use the first separate debug info file location searched by GDB so the
3403 # run cannot be broken by some stale file searched with higher precedence.
3404 set debug_file "${dest}.debug"
3405
b741e217
DJ
3406 set strip_to_file_program [transform strip]
3407 set objcopy_program [transform objcopy]
1f8a6abb 3408
1f8a6abb
EZ
3409 set debug_link [file tail $debug_file]
3410 set stripped_file "${dest}.stripped"
3411
3412 # Get rid of the debug info, and store result in stripped_file
3413 # something like gdb/testsuite/gdb.base/blah.stripped.
3414 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
3415 verbose "result is $result"
3416 verbose "output is $output"
3417 if {$result == 1} {
3418 return 1
3419 }
3420
d521f563
JK
3421 # Workaround PR binutils/10802:
3422 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
3423 set perm [file attributes ${dest} -permissions]
3424 file attributes ${stripped_file} -permissions $perm
3425
1f8a6abb
EZ
3426 # Get rid of everything but the debug info, and store result in debug_file
3427 # This will be in the .debug subdirectory, see above.
3428 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
3429 verbose "result is $result"
3430 verbose "output is $output"
3431 if {$result == 1} {
3432 return 1
3433 }
3434
94277a38
DJ
3435 # If no-main is passed, strip the symbol for main from the separate
3436 # file. This is to simulate the behavior of elfutils's eu-strip, which
3437 # leaves the symtab in the original file only. There's no way to get
3438 # objcopy or strip to remove the symbol table without also removing the
3439 # debugging sections, so this is as close as we can get.
3440 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
3441 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
3442 verbose "result is $result"
3443 verbose "output is $output"
3444 if {$result == 1} {
3445 return 1
3446 }
3447 file delete "${debug_file}"
3448 file rename "${debug_file}-tmp" "${debug_file}"
3449 }
3450
1f8a6abb
EZ
3451 # Link the two previous output files together, adding the .gnu_debuglink
3452 # section to the stripped_file, containing a pointer to the debug_file,
3453 # save the new file in dest.
3454 # This will be the regular executable filename, in the usual location.
3455 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
3456 verbose "result is $result"
3457 verbose "output is $output"
3458 if {$result == 1} {
3459 return 1
3460 }
3461
d521f563
JK
3462 # Workaround PR binutils/10802:
3463 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
3464 set perm [file attributes ${stripped_file} -permissions]
3465 file attributes ${dest} -permissions $perm
3466
3467 return 0
1f8a6abb
EZ
3468}
3469
d8295fe9
VP
3470# Test the output of GDB_COMMAND matches the pattern obtained
3471# by concatenating all elements of EXPECTED_LINES. This makes
3472# it possible to split otherwise very long string into pieces.
3473# If third argument is not empty, it's used as the name of the
3474# test to be printed on pass/fail.
3475proc help_test_raw { gdb_command expected_lines args } {
3476 set message $gdb_command
3477 if [llength $args]>0 then {
3478 set message [lindex $args 0]
3479 }
3480 set expected_output [join $expected_lines ""]
3481 gdb_test "${gdb_command}" "${expected_output}" $message
3482}
3483
3484# Test the output of "help COMMNAD_CLASS". EXPECTED_INITIAL_LINES
3485# are regular expressions that should match the beginning of output,
3486# before the list of commands in that class. The presence of
3487# command list and standard epilogue will be tested automatically.
3488proc test_class_help { command_class expected_initial_lines args } {
3489 set l_stock_body {
3490 "List of commands\:.*\[\r\n\]+"
3491 "Type \"help\" followed by command name for full documentation\.\[\r\n\]+"
3492 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+"
3493 "Command name abbreviations are allowed if unambiguous\."
3494 }
3495 set l_entire_body [concat $expected_initial_lines $l_stock_body]
3496
3497 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
3498}
3499
3500# COMMAND_LIST should have either one element -- command to test, or
3501# two elements -- abbreviated command to test, and full command the first
3502# element is abbreviation of.
3503# The command must be a prefix command. EXPECTED_INITIAL_LINES
3504# are regular expressions that should match the beginning of output,
3505# before the list of subcommands. The presence of
3506# subcommand list and standard epilogue will be tested automatically.
3507proc test_prefix_command_help { command_list expected_initial_lines args } {
3508 set command [lindex $command_list 0]
3509 if {[llength $command_list]>1} {
3510 set full_command [lindex $command_list 1]
3511 } else {
3512 set full_command $command
3513 }
3514 # Use 'list' and not just {} because we want variables to
3515 # be expanded in this list.
3516 set l_stock_body [list\
3517 "List of $full_command subcommands\:.*\[\r\n\]+"\
3518 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
3519 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
3520 "Command name abbreviations are allowed if unambiguous\."]
3521 set l_entire_body [concat $expected_initial_lines $l_stock_body]
3522 if {[llength $args]>0} {
3523 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
3524 } else {
3525 help_test_raw "help ${command}" $l_entire_body
3526 }
3527}
dbc52822
VP
3528
3529# Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
3530# provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
3531# to pass to untested, if something is wrong. OPTIONS are passed
3532# to gdb_compile directly.
3533proc build_executable { testname executable {sources ""} {options {debug}} } {
3534
3535 global objdir
3536 global subdir
3537 global srcdir
3538 if {[llength $sources]==0} {
3539 set sources ${executable}.c
3540 }
3541
3542 set binfile ${objdir}/${subdir}/${executable}
3543
3544 set objects {}
3545 for {set i 0} "\$i<[llength $sources]" {incr i} {
3546 set s [lindex $sources $i]
3547 if { [gdb_compile "${srcdir}/${subdir}/${s}" "${binfile}${i}.o" object $options] != "" } {
3548 untested $testname
3549 return -1
3550 }
3551 lappend objects "${binfile}${i}.o"
3552 }
3553
3554 if { [gdb_compile $objects "${binfile}" executable $options] != "" } {
3555 untested $testname
3556 return -1
3557 }
3558
fd961404
DE
3559 set info_options ""
3560 if { [lsearch -exact $options "c++"] >= 0 } {
3561 set info_options "c++"
3562 }
3563 if [get_compiler_info ${binfile} ${info_options}] {
dbc52822
VP
3564 return -1
3565 }
3566 return 0
3567}
3568
3569# Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
3570# the name of binary in ${objdir}/${subdir}.
3571proc clean_restart { executable } {
3572 global srcdir
3573 global objdir
3574 global subdir
3575 set binfile ${objdir}/${subdir}/${executable}
3576
3577 gdb_exit
3578 gdb_start
3579 gdb_reinitialize_dir $srcdir/$subdir
3580 gdb_load ${binfile}
3581
3582 if [target_info exists gdb_stub] {
3583 gdb_step_for_stub;
3584 }
3585}
3586
3587# Prepares for testing, by calling build_executable, and then clean_restart.
3588# Please refer to build_executable for parameter description.
3589proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
3590
734a5c36 3591 if {[build_executable $testname $executable $sources $options] == -1} {
dbc52822
VP
3592 return -1
3593 }
3594 clean_restart $executable
3595
3596 return 0
3597}
7065b901
TT
3598
3599proc get_valueof { fmt exp default } {
3600 global gdb_prompt
3601
3602 set test "get valueof \"${exp}\""
3603 set val ${default}
3604 gdb_test_multiple "print${fmt} ${exp}" "$test" {
417e16e2
PM
3605 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
3606 set val $expect_out(1,string)
3607 pass "$test ($val)"
3608 }
3609 timeout {
3610 fail "$test (timeout)"
3611 }
3612 }
3613 return ${val}
3614}
3615
3616proc get_integer_valueof { exp default } {
3617 global gdb_prompt
3618
3619 set test "get integer valueof \"${exp}\""
3620 set val ${default}
3621 gdb_test_multiple "print /d ${exp}" "$test" {
7065b901
TT
3622 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
3623 set val $expect_out(1,string)
3624 pass "$test ($val)"
3625 }
3626 timeout {
417e16e2 3627 fail "$test (timeout)"
7065b901
TT
3628 }
3629 }
3630 return ${val}
3631}
3632
faafb047
PM
3633proc get_hexadecimal_valueof { exp default } {
3634 global gdb_prompt
3635 send_gdb "print /x ${exp}\n"
3636 set test "get hexadecimal valueof \"${exp}\""
3637 gdb_expect {
3638 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
3639 set val $expect_out(1,string)
3640 pass "$test"
3641 }
3642 timeout {
3643 set val ${default}
3644 fail "$test (timeout)"
3645 }
3646 }
3647 return ${val}
3648}
417e16e2 3649
7065b901 3650proc get_sizeof { type default } {
417e16e2 3651 return [get_integer_valueof "sizeof (${type})" $default]
7065b901
TT
3652}
3653
db863c42
MF
3654# Get the current value for remotetimeout and return it.
3655proc get_remotetimeout { } {
3656 global gdb_prompt
3657 global decimal
3658
3659 gdb_test_multiple "show remotetimeout" "" {
3660 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
3661 return $expect_out(1,string);
3662 }
3663 }
3664
3665 # Pick the default that gdb uses
3666 warning "Unable to read remotetimeout"
3667 return 300
3668}
3669
3670# Set the remotetimeout to the specified timeout. Nothing is returned.
3671proc set_remotetimeout { timeout } {
3672 global gdb_prompt
3673
3674 gdb_test_multiple "set remotetimeout $timeout" "" {
3675 -re "$gdb_prompt $" {
3676 verbose "Set remotetimeout to $timeout\n"
3677 }
3678 }
3679}
3680
812f7342
TT
3681# Log gdb command line and script if requested.
3682if {[info exists TRANSCRIPT]} {
3683 rename send_gdb real_send_gdb
3684 rename remote_spawn real_remote_spawn
3685 rename remote_close real_remote_close
3686
3687 global gdb_transcript
3688 set gdb_transcript ""
3689
3690 global gdb_trans_count
3691 set gdb_trans_count 1
3692
3693 proc remote_spawn {args} {
3694 global gdb_transcript gdb_trans_count outdir
3695
3696 if {$gdb_transcript != ""} {
3697 close $gdb_transcript
3698 }
3699 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
3700 puts $gdb_transcript [lindex $args 1]
3701 incr gdb_trans_count
3702
3703 return [uplevel real_remote_spawn $args]
3704 }
3705
3706 proc remote_close {args} {
3707 global gdb_transcript
3708
3709 if {$gdb_transcript != ""} {
3710 close $gdb_transcript
3711 set gdb_transcript ""
3712 }
3713
3714 return [uplevel real_remote_close $args]
3715 }
3716
3717 proc send_gdb {args} {
3718 global gdb_transcript
3719
3720 if {$gdb_transcript != ""} {
3721 puts -nonewline $gdb_transcript [lindex $args 0]
3722 }
3723
3724 return [uplevel real_send_gdb $args]
3725 }
3726}
37aeb5df 3727
bbfba9ed 3728proc core_find {binfile {deletefiles {}} {arg ""}} {
37aeb5df
JK
3729 global objdir subdir
3730
3731 set destcore "$binfile.core"
3732 file delete $destcore
3733
3734 # Create a core file named "$destcore" rather than just "core", to
3735 # avoid problems with sys admin types that like to regularly prune all
3736 # files named "core" from the system.
3737 #
3738 # Arbitrarily try setting the core size limit to "unlimited" since
3739 # this does not hurt on systems where the command does not work and
3740 # allows us to generate a core on systems where it does.
3741 #
3742 # Some systems append "core" to the name of the program; others append
3743 # the name of the program to "core"; still others (like Linux, as of
3744 # May 2003) create cores named "core.PID". In the latter case, we
3745 # could have many core files lying around, and it may be difficult to
3746 # tell which one is ours, so let's run the program in a subdirectory.
3747 set found 0
3748 set coredir "${objdir}/${subdir}/coredir.[getpid]"
3749 file mkdir $coredir
bbfba9ed 3750 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
37aeb5df
JK
3751 # remote_exec host "${binfile}"
3752 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
3753 if [remote_file build exists $i] {
3754 remote_exec build "mv $i $destcore"
3755 set found 1
3756 }
3757 }
3758 # Check for "core.PID".
3759 if { $found == 0 } {
3760 set names [glob -nocomplain -directory $coredir core.*]
3761 if {[llength $names] == 1} {
3762 set corefile [file join $coredir [lindex $names 0]]
3763 remote_exec build "mv $corefile $destcore"
3764 set found 1
3765 }
3766 }
3767 if { $found == 0 } {
3768 # The braindamaged HPUX shell quits after the ulimit -c above
3769 # without executing ${binfile}. So we try again without the
3770 # ulimit here if we didn't find a core file above.
3771 # Oh, I should mention that any "braindamaged" non-Unix system has
3772 # the same problem. I like the cd bit too, it's really neat'n stuff.
3773 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
3774 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
3775 if [remote_file build exists $i] {
3776 remote_exec build "mv $i $destcore"
3777 set found 1
3778 }
3779 }
3780 }
3781
3782 # Try to clean up after ourselves.
3783 foreach deletefile $deletefiles {
3784 remote_file build delete [file join $coredir $deletefile]
3785 }
3786 remote_exec build "rmdir $coredir"
3787
3788 if { $found == 0 } {
3789 warning "can't generate a core file - core tests suppressed - check ulimit -c"
3790 return ""
3791 }
3792 return $destcore
3793}
ee5683ab
PM
3794
3795# gdb_target_symbol_prefix_flags returns a string that can be added
3796# to gdb_compile options to define SYMBOL_PREFIX macro value
3797# symbol_prefix_flags returns a string that can be added
3798# for targets that use underscore as symbol prefix.
3799# TODO: find out automatically if the target needs this.
3800
3801proc gdb_target_symbol_prefix_flags {} {
3802 if { [istarget "*-*-cygwin*"] || [istarget "i?86-*-mingw*"]
3803 || [istarget "*-*-msdosdjgpp*"] || [istarget "*-*-go32*"] } {
3804 return "additional_flags=-DSYMBOL_PREFIX=\"_\""
3805 } else {
3806 return ""
3807 }
3808}
3809
42159ca5
TT
3810# Always load compatibility stuff.
3811load_lib future.exp
This page took 1.407183 seconds and 4 git commands to generate.