testsuite: Introduce gdb_assert
[deliverable/binutils-gdb.git] / gdb / testsuite / lib / gdb.exp
CommitLineData
ecd75fc8 1# Copyright 1992-2014 Free Software Foundation, Inc.
c906108c
SS
2
3# This program is free software; you can redistribute it and/or modify
4# it under the terms of the GNU General Public License as published by
e22f8b7c 5# the Free Software Foundation; either version 3 of the License, or
c906108c 6# (at your option) any later version.
e22f8b7c 7#
c906108c
SS
8# This program is distributed in the hope that it will be useful,
9# but WITHOUT ANY WARRANTY; without even the implied warranty of
10# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11# GNU General Public License for more details.
e22f8b7c 12#
c906108c 13# You should have received a copy of the GNU General Public License
e22f8b7c 14# along with this program. If not, see <http://www.gnu.org/licenses/>.
c906108c 15
c906108c
SS
16# This file was written by Fred Fish. (fnf@cygnus.com)
17
18# Generic gdb subroutines that should work for any target. If these
19# need to be modified for any target, it can be done with a variable
20# or by passing arguments.
21
97c3f1f3
JK
22if {$tool == ""} {
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
25 exit 2
26}
27
c906108c 28load_lib libgloss.exp
17e1c970 29load_lib cache.exp
a25eb028 30load_lib gdb-utils.exp
c906108c
SS
31
32global GDB
c906108c
SS
33
34if [info exists TOOL_EXECUTABLE] {
4ec70201 35 set GDB $TOOL_EXECUTABLE
c906108c
SS
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 {
4ec70201 41 set GDB [transform gdb]
c906108c
SS
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
2f4e0a80
DE
57# Make the build data directory available to tests.
58set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
59
6b8ce727 60# INTERNAL_GDBFLAGS contains flags that the testsuite requires.
1be00882
DE
61global INTERNAL_GDBFLAGS
62if ![info exists INTERNAL_GDBFLAGS] {
2f4e0a80 63 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
1be00882 64}
6b8ce727 65
9e0b60a8
JM
66# The variable gdb_prompt is a regexp which matches the gdb prompt.
67# Set it if it is not already set.
c906108c 68global gdb_prompt
9e0b60a8 69if ![info exists gdb_prompt] then {
c906108c
SS
70 set gdb_prompt "\[(\]gdb\[)\]"
71}
72
6006a3a1
BR
73# The variable fullname_syntax_POSIX is a regexp which matches a POSIX
74# absolute path ie. /foo/
d0b76dc6 75set fullname_syntax_POSIX {/[^\n]*/}
6006a3a1
BR
76# The variable fullname_syntax_UNC is a regexp which matches a Windows
77# UNC path ie. \\D\foo\
d0b76dc6 78set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
6006a3a1
BR
79# The variable fullname_syntax_DOS_CASE is a regexp which matches a
80# particular DOS case that GDB most likely will output
81# ie. \foo\, but don't match \\.*\
d0b76dc6 82set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
6006a3a1
BR
83# The variable fullname_syntax_DOS is a regexp which matches a DOS path
84# ie. a:\foo\ && a:foo\
d0b76dc6 85set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
6006a3a1
BR
86# The variable fullname_syntax is a regexp which matches what GDB considers
87# an absolute path. It is currently debatable if the Windows style paths
88# d:foo and \abc should be considered valid as an absolute path.
89# Also, the purpse of this regexp is not to recognize a well formed
90# absolute path, but to say with certainty that a path is absolute.
91set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
92
93076499
ND
93# Needed for some tests under Cygwin.
94global EXEEXT
95global env
96
97if ![info exists env(EXEEXT)] {
98 set EXEEXT ""
99} else {
100 set EXEEXT $env(EXEEXT)
101}
102
bb2bed55
NR
103set octal "\[0-7\]+"
104
eceb0c5f 105set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
fda326dd 106
085dd6e6
JM
107### Only procedures should come after this point.
108
c906108c
SS
109#
110# gdb_version -- extract and print the version number of GDB
111#
112proc default_gdb_version {} {
113 global GDB
6b8ce727 114 global INTERNAL_GDBFLAGS GDBFLAGS
c906108c 115 global gdb_prompt
5e92f71a
TT
116 global inotify_pid
117
118 if {[info exists inotify_pid]} {
119 eval exec kill $inotify_pid
120 }
121
fa335448 122 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
4ec70201 123 set tmp [lindex $output 1]
c906108c
SS
124 set version ""
125 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
126 if ![is_remote host] {
6b8ce727 127 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
c906108c 128 } else {
6b8ce727 129 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
c906108c
SS
130 }
131}
132
133proc gdb_version { } {
ae59b1da 134 return [default_gdb_version]
c906108c
SS
135}
136
137#
138# gdb_unload -- unload a file if one is loaded
608e2dbb 139# Return 0 on success, -1 on error.
c906108c
SS
140#
141
142proc gdb_unload {} {
143 global verbose
144 global GDB
145 global gdb_prompt
146 send_gdb "file\n"
147 gdb_expect 60 {
148 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
149 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
959e7469
PM
150 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
151 send_gdb "y\n"
c906108c
SS
152 exp_continue
153 }
154 -re "Discard symbol table from .*y or n.*$" {
155 send_gdb "y\n"
156 exp_continue
157 }
158 -re "$gdb_prompt $" {}
159 timeout {
975531db 160 perror "couldn't unload file in $GDB (timeout)."
c906108c
SS
161 return -1
162 }
163 }
608e2dbb 164 return 0
c906108c
SS
165}
166
167# Many of the tests depend on setting breakpoints at various places and
168# running until that breakpoint is reached. At times, we want to start
169# with a clean-slate with respect to breakpoints, so this utility proc
170# lets us do this without duplicating this code everywhere.
171#
172
173proc delete_breakpoints {} {
174 global gdb_prompt
175
a0b3c4fd
JM
176 # we need a larger timeout value here or this thing just confuses
177 # itself. May need a better implementation if possible. - guo
178 #
c906108c 179 send_gdb "delete breakpoints\n"
a0b3c4fd 180 gdb_expect 100 {
c906108c 181 -re "Delete all breakpoints.*y or n.*$" {
4ec70201 182 send_gdb "y\n"
c906108c
SS
183 exp_continue
184 }
185 -re "$gdb_prompt $" { # This happens if there were no breakpoints
186 }
187 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
188 }
189 send_gdb "info breakpoints\n"
a0b3c4fd 190 gdb_expect 100 {
c906108c
SS
191 -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
192 -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
193 -re "Delete all breakpoints.*or n.*$" {
4ec70201 194 send_gdb "y\n"
c906108c
SS
195 exp_continue
196 }
197 timeout { perror "info breakpoints (timeout)" ; return }
198 }
199}
200
c906108c
SS
201# Generic run command.
202#
203# The second pattern below matches up to the first newline *only*.
204# Using ``.*$'' could swallow up output that we attempt to match
205# elsewhere.
206#
1d41d75c
DE
207# N.B. This function does not wait for gdb to return to the prompt,
208# that is the caller's responsibility.
209
c906108c 210proc gdb_run_cmd {args} {
e11ac3a3 211 global gdb_prompt use_gdb_stub
c906108c 212
a25eb028
MR
213 foreach command [gdb_init_commands] {
214 send_gdb "$command\n"
c906108c
SS
215 gdb_expect 30 {
216 -re "$gdb_prompt $" { }
217 default {
4ec70201
PA
218 perror "gdb_init_command for target failed"
219 return
c906108c
SS
220 }
221 }
222 }
223
e11ac3a3 224 if $use_gdb_stub {
c906108c 225 if [target_info exists gdb,do_reload_on_run] {
b741e217 226 if { [gdb_reload] != 0 } {
4ec70201 227 return
917317f4 228 }
4ec70201 229 send_gdb "continue\n"
c906108c
SS
230 gdb_expect 60 {
231 -re "Continu\[^\r\n\]*\[\r\n\]" {}
232 default {}
233 }
4ec70201 234 return
c906108c
SS
235 }
236
237 if [target_info exists gdb,start_symbol] {
4ec70201 238 set start [target_info gdb,start_symbol]
c906108c 239 } else {
4ec70201 240 set start "start"
c906108c
SS
241 }
242 send_gdb "jump *$start\n"
4ec70201 243 set start_attempt 1
917317f4
JM
244 while { $start_attempt } {
245 # Cap (re)start attempts at three to ensure that this loop
246 # always eventually fails. Don't worry about trying to be
247 # clever and not send a command when it has failed.
248 if [expr $start_attempt > 3] {
4ec70201
PA
249 perror "Jump to start() failed (retry count exceeded)"
250 return
c906108c 251 }
4ec70201 252 set start_attempt [expr $start_attempt + 1]
917317f4
JM
253 gdb_expect 30 {
254 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
4ec70201 255 set start_attempt 0
917317f4
JM
256 }
257 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
4ec70201
PA
258 perror "Can't find start symbol to run in gdb_run"
259 return
917317f4
JM
260 }
261 -re "No symbol \"start\" in current.*$gdb_prompt $" {
4ec70201 262 send_gdb "jump *_start\n"
917317f4
JM
263 }
264 -re "No symbol.*context.*$gdb_prompt $" {
4ec70201 265 set start_attempt 0
917317f4
JM
266 }
267 -re "Line.* Jump anyway.*y or n. $" {
268 send_gdb "y\n"
269 }
270 -re "The program is not being run.*$gdb_prompt $" {
b741e217 271 if { [gdb_reload] != 0 } {
4ec70201 272 return
917317f4 273 }
4ec70201 274 send_gdb "jump *$start\n"
917317f4
JM
275 }
276 timeout {
4ec70201 277 perror "Jump to start() failed (timeout)"
917317f4
JM
278 return
279 }
c906108c 280 }
c906108c 281 }
c906108c
SS
282 return
283 }
83f66e8f
DJ
284
285 if [target_info exists gdb,do_reload_on_run] {
b741e217 286 if { [gdb_reload] != 0 } {
4ec70201 287 return
83f66e8f
DJ
288 }
289 }
c906108c
SS
290 send_gdb "run $args\n"
291# This doesn't work quite right yet.
5aa7ddc2
PM
292# Use -notransfer here so that test cases (like chng-sym.exp)
293# may test for additional start-up messages.
294 gdb_expect 60 {
c906108c
SS
295 -re "The program .* has been started already.*y or n. $" {
296 send_gdb "y\n"
297 exp_continue
298 }
bbb88ebf 299 -notransfer -re "Starting program: \[^\r\n\]*" {}
8e46892c
JK
300 -notransfer -re "$gdb_prompt $" {
301 # There is no more input expected.
302 }
c906108c
SS
303 }
304}
305
b741e217
DJ
306# Generic start command. Return 0 if we could start the program, -1
307# if we could not.
1d41d75c
DE
308#
309# N.B. This function does not wait for gdb to return to the prompt,
310# that is the caller's responsibility.
b741e217
DJ
311
312proc gdb_start_cmd {args} {
e11ac3a3 313 global gdb_prompt use_gdb_stub
b741e217 314
a25eb028
MR
315 foreach command [gdb_init_commands] {
316 send_gdb "$command\n"
b741e217
DJ
317 gdb_expect 30 {
318 -re "$gdb_prompt $" { }
319 default {
4ec70201 320 perror "gdb_init_command for target failed"
ae59b1da 321 return -1
b741e217
DJ
322 }
323 }
324 }
325
e11ac3a3 326 if $use_gdb_stub {
b741e217
DJ
327 return -1
328 }
329
330 send_gdb "start $args\n"
2de75e71
JB
331 # Use -notransfer here so that test cases (like chng-sym.exp)
332 # may test for additional start-up messages.
b741e217
DJ
333 gdb_expect 60 {
334 -re "The program .* has been started already.*y or n. $" {
335 send_gdb "y\n"
336 exp_continue
337 }
b741e217
DJ
338 -notransfer -re "Starting program: \[^\r\n\]*" {
339 return 0
340 }
341 }
342 return -1
343}
344
78a1a894 345# Set a breakpoint at FUNCTION. If there is an additional argument it is
55cd6f92 346# a list of options; the supported options are allow-pending, temporary,
5b7d0050
DE
347# message, no-message, and passfail.
348# The result is 1 for success, 0 for failure.
349#
350# Note: The handling of message vs no-message is messed up, but it's based
351# on historical usage. By default this function does not print passes,
352# only fails.
353# no-message: turns off printing of fails (and passes, but they're already off)
354# message: turns on printing of passes (and fails, but they're already on)
78a1a894
DJ
355
356proc gdb_breakpoint { function args } {
c906108c
SS
357 global gdb_prompt
358 global decimal
359
78a1a894 360 set pending_response n
5b7d0050 361 if {[lsearch -exact $args allow-pending] != -1} {
78a1a894
DJ
362 set pending_response y
363 }
364
e48883f7 365 set break_command "break"
18ac113b 366 set break_message "Breakpoint"
5b7d0050 367 if {[lsearch -exact $args temporary] != -1} {
e48883f7 368 set break_command "tbreak"
18ac113b 369 set break_message "Temporary breakpoint"
e48883f7
DJ
370 }
371
5b7d0050
DE
372 set print_pass 0
373 set print_fail 1
374 set no_message_loc [lsearch -exact $args no-message]
375 set message_loc [lsearch -exact $args message]
376 # The last one to appear in args wins.
377 if { $no_message_loc > $message_loc } {
378 set print_fail 0
379 } elseif { $message_loc > $no_message_loc } {
380 set print_pass 1
55cd6f92
DJ
381 }
382
5b7d0050
DE
383 set test_name "setting breakpoint at $function"
384
e48883f7 385 send_gdb "$break_command $function\n"
c906108c
SS
386 # The first two regexps are what we get with -g, the third is without -g.
387 gdb_expect 30 {
18ac113b
AR
388 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
389 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
390 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
391 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
78a1a894 392 if {$pending_response == "n"} {
5b7d0050
DE
393 if { $print_fail } {
394 fail $test_name
55cd6f92 395 }
78a1a894
DJ
396 return 0
397 }
398 }
9f27c604 399 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
78a1a894 400 send_gdb "$pending_response\n"
14b1a056 401 exp_continue
18fe2033 402 }
28781456 403 -re "A problem internal to GDB has been detected" {
5b7d0050
DE
404 if { $print_fail } {
405 fail "$test_name (GDB internal error)"
406 }
28781456
JK
407 gdb_internal_error_resync
408 return 0
409 }
55cd6f92 410 -re "$gdb_prompt $" {
5b7d0050
DE
411 if { $print_fail } {
412 fail $test_name
413 }
414 return 0
415 }
416 eof {
417 if { $print_fail } {
418 fail "$test_name (eof)"
55cd6f92
DJ
419 }
420 return 0
421 }
422 timeout {
5b7d0050
DE
423 if { $print_fail } {
424 fail "$test_name (timeout)"
55cd6f92
DJ
425 }
426 return 0
427 }
c906108c 428 }
5b7d0050
DE
429 if { $print_pass } {
430 pass $test_name
431 }
ae59b1da 432 return 1
c906108c
SS
433}
434
435# Set breakpoint at function and run gdb until it breaks there.
436# Since this is the only breakpoint that will be set, if it stops
437# at a breakpoint, we will assume it is the one we want. We can't
438# just compare to "function" because it might be a fully qualified,
5b7d0050
DE
439# single quoted C++ function specifier.
440#
441# If there are additional arguments, pass them to gdb_breakpoint.
442# We recognize no-message/message ourselves.
443# The default is no-message.
444# no-message is messed up here, like gdb_breakpoint: to preserve
445# historical usage fails are always printed by default.
446# no-message: turns off printing of fails (and passes, but they're already off)
447# message: turns on printing of passes (and fails, but they're already on)
c906108c 448
78a1a894 449proc runto { function args } {
c906108c
SS
450 global gdb_prompt
451 global decimal
452
453 delete_breakpoints
454
5b7d0050
DE
455 # Default to "no-message".
456 set args "no-message $args"
457
458 set print_pass 0
459 set print_fail 1
460 set no_message_loc [lsearch -exact $args no-message]
461 set message_loc [lsearch -exact $args message]
462 # The last one to appear in args wins.
463 if { $no_message_loc > $message_loc } {
464 set print_fail 0
465 } elseif { $message_loc > $no_message_loc } {
466 set print_pass 1
467 }
468
469 set test_name "running to $function in runto"
470
471 # We need to use eval here to pass our varargs args to gdb_breakpoint
472 # which is also a varargs function.
2c47921e
DE
473 # But we also have to be careful because $function may have multiple
474 # elements, and we don't want Tcl to move the remaining elements after
475 # the first to $args. That is why $function is wrapped in {}.
476 if ![eval gdb_breakpoint {$function} $args] {
ae59b1da 477 return 0
c906108c
SS
478 }
479
480 gdb_run_cmd
481
482 # the "at foo.c:36" output we get with -g.
483 # the "in func" output we get without -g.
484 gdb_expect 30 {
485 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
5b7d0050
DE
486 if { $print_pass } {
487 pass $test_name
488 }
c906108c
SS
489 return 1
490 }
491 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
5b7d0050
DE
492 if { $print_pass } {
493 pass $test_name
494 }
c906108c
SS
495 return 1
496 }
8e46892c 497 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
5b7d0050
DE
498 if { $print_fail } {
499 unsupported "Non-stop mode not supported"
500 }
8e46892c
JK
501 return 0
502 }
569b05a5 503 -re ".*A problem internal to GDB has been detected" {
5b7d0050
DE
504 if { $print_fail } {
505 fail "$test_name (GDB internal error)"
506 }
569b05a5
JK
507 gdb_internal_error_resync
508 return 0
509 }
c906108c 510 -re "$gdb_prompt $" {
5b7d0050
DE
511 if { $print_fail } {
512 fail $test_name
513 }
c906108c
SS
514 return 0
515 }
72c63395 516 eof {
5b7d0050
DE
517 if { $print_fail } {
518 fail "$test_name (eof)"
519 }
72c63395
JK
520 return 0
521 }
c906108c 522 timeout {
5b7d0050
DE
523 if { $print_fail } {
524 fail "$test_name (timeout)"
525 }
c906108c
SS
526 return 0
527 }
528 }
5b7d0050
DE
529 if { $print_pass } {
530 pass $test_name
531 }
c906108c
SS
532 return 1
533}
534
1d41d75c 535# Ask gdb to run until we hit a breakpoint at main.
c906108c 536#
1d41d75c
DE
537# N.B. This function deletes all existing breakpoints.
538# If you don't want that, use gdb_start_cmd.
539
c906108c 540proc runto_main { } {
5b7d0050 541 return [runto main no-message]
c906108c
SS
542}
543
4ce44c66
JM
544### Continue, and expect to hit a breakpoint.
545### Report a pass or fail, depending on whether it seems to have
546### worked. Use NAME as part of the test name; each call to
547### continue_to_breakpoint should use a NAME which is unique within
548### that test file.
74960c60 549proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
4ce44c66
JM
550 global gdb_prompt
551 set full_name "continue to breakpoint: $name"
552
06d97543 553 gdb_test_multiple "continue" $full_name {
a1624241 554 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
4ce44c66
JM
555 pass $full_name
556 }
4ce44c66
JM
557 }
558}
559
560
039cf96d
AC
561# gdb_internal_error_resync:
562#
563# Answer the questions GDB asks after it reports an internal error
564# until we get back to a GDB prompt. Decline to quit the debugging
565# session, and decline to create a core file. Return non-zero if the
566# resync succeeds.
567#
568# This procedure just answers whatever questions come up until it sees
569# a GDB prompt; it doesn't require you to have matched the input up to
570# any specific point. However, it only answers questions it sees in
571# the output itself, so if you've matched a question, you had better
572# answer it yourself before calling this.
573#
574# You can use this function thus:
575#
576# gdb_expect {
577# ...
578# -re ".*A problem internal to GDB has been detected" {
579# gdb_internal_error_resync
580# }
581# ...
582# }
583#
584proc gdb_internal_error_resync {} {
585 global gdb_prompt
586
5b7d0050
DE
587 verbose -log "Resyncing due to internal error."
588
039cf96d
AC
589 set count 0
590 while {$count < 10} {
591 gdb_expect {
592 -re "Quit this debugging session\\? \\(y or n\\) $" {
593 send_gdb "n\n"
594 incr count
595 }
596 -re "Create a core file of GDB\\? \\(y or n\\) $" {
597 send_gdb "n\n"
598 incr count
599 }
600 -re "$gdb_prompt $" {
601 # We're resynchronized.
602 return 1
603 }
604 timeout {
605 perror "Could not resync from internal error (timeout)"
606 return 0
607 }
608 }
609 }
2b211c59
AC
610 perror "Could not resync from internal error (resync count exceeded)"
611 return 0
039cf96d
AC
612}
613
4ce44c66 614
2307bd6a 615# gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
8dbfb380 616# Send a command to gdb; test the result.
c906108c
SS
617#
618# COMMAND is the command to execute, send to GDB with send_gdb. If
619# this is the null string no command is sent.
2307bd6a
DJ
620# MESSAGE is a message to be printed with the built-in failure patterns
621# if one of them matches. If MESSAGE is empty COMMAND will be used.
622# EXPECT_ARGUMENTS will be fed to expect in addition to the standard
623# patterns. Pattern elements will be evaluated in the caller's
624# context; action elements will be executed in the caller's context.
625# Unlike patterns for gdb_test, these patterns should generally include
626# the final newline and prompt.
c906108c
SS
627#
628# Returns:
2307bd6a
DJ
629# 1 if the test failed, according to a built-in failure pattern
630# 0 if only user-supplied patterns matched
c906108c
SS
631# -1 if there was an internal error.
632#
d422fe19
AC
633# You can use this function thus:
634#
635# gdb_test_multiple "print foo" "test foo" {
636# -re "expected output 1" {
637# pass "print foo"
638# }
639# -re "expected output 2" {
640# fail "print foo"
641# }
642# }
643#
fda326dd 644# The standard patterns, such as "Inferior exited..." and "A problem
d422fe19
AC
645# ...", all being implicitly appended to that list.
646#
2307bd6a 647proc gdb_test_multiple { command message user_code } {
e11ac3a3 648 global verbose use_gdb_stub
c906108c
SS
649 global gdb_prompt
650 global GDB
fda326dd 651 global inferior_exited_re
c906108c 652 upvar timeout timeout
c47cebdb 653 upvar expect_out expect_out
c906108c 654
2307bd6a
DJ
655 if { $message == "" } {
656 set message $command
c906108c 657 }
c906108c 658
824cc8dd
JK
659 if [string match "*\[\r\n\]" $command] {
660 error "Invalid trailing newline in \"$message\" test"
661 }
662
8344e389
JK
663 if [string match "*\[\r\n\]*" $message] {
664 error "Invalid newline in \"$message\" test"
665 }
666
e11ac3a3 667 if {$use_gdb_stub
9bfee719 668 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
e11ac3a3
JK
669 $command]} {
670 error "gdbserver does not support $command without extended-remote"
671 }
672
2307bd6a
DJ
673 # TCL/EXPECT WART ALERT
674 # Expect does something very strange when it receives a single braced
675 # argument. It splits it along word separators and performs substitutions.
676 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
677 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
678 # double-quoted list item, "\[ab\]" is just a long way of representing
679 # "[ab]", because the backslashes will be removed by lindex.
680
681 # Unfortunately, there appears to be no easy way to duplicate the splitting
682 # that expect will do from within TCL. And many places make use of the
683 # "\[0-9\]" construct, so we need to support that; and some places make use
684 # of the "[func]" construct, so we need to support that too. In order to
685 # get this right we have to substitute quoted list elements differently
686 # from braced list elements.
687
688 # We do this roughly the same way that Expect does it. We have to use two
689 # lists, because if we leave unquoted newlines in the argument to uplevel
690 # they'll be treated as command separators, and if we escape newlines
691 # we mangle newlines inside of command blocks. This assumes that the
692 # input doesn't contain a pattern which contains actual embedded newlines
693 # at this point!
694
695 regsub -all {\n} ${user_code} { } subst_code
696 set subst_code [uplevel list $subst_code]
697
698 set processed_code ""
699 set patterns ""
700 set expecting_action 0
21e24d21 701 set expecting_arg 0
2307bd6a
DJ
702 foreach item $user_code subst_item $subst_code {
703 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
704 lappend processed_code $item
705 continue
706 }
21e24d21
PA
707 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
708 lappend processed_code $item
709 continue
710 }
711 if { $item == "-timeout" } {
712 set expecting_arg 1
713 lappend processed_code $item
714 continue
715 }
716 if { $expecting_arg } {
717 set expecting_arg 0
2307bd6a
DJ
718 lappend processed_code $item
719 continue
720 }
721 if { $expecting_action } {
722 lappend processed_code "uplevel [list $item]"
723 set expecting_action 0
724 # Cosmetic, no effect on the list.
725 append processed_code "\n"
726 continue
727 }
728 set expecting_action 1
729 lappend processed_code $subst_item
730 if {$patterns != ""} {
731 append patterns "; "
732 }
733 append patterns "\"$subst_item\""
c906108c
SS
734 }
735
2307bd6a
DJ
736 # Also purely cosmetic.
737 regsub -all {\r} $patterns {\\r} patterns
738 regsub -all {\n} $patterns {\\n} patterns
739
c906108c
SS
740 if $verbose>2 then {
741 send_user "Sending \"$command\" to gdb\n"
2307bd6a 742 send_user "Looking to match \"$patterns\"\n"
c906108c
SS
743 send_user "Message is \"$message\"\n"
744 }
745
746 set result -1
4ec70201 747 set string "${command}\n"
c906108c 748 if { $command != "" } {
543a9323 749 set multi_line_re "\[\r\n\] *>"
c906108c 750 while { "$string" != "" } {
4ec70201
PA
751 set foo [string first "\n" "$string"]
752 set len [string length "$string"]
c906108c 753 if { $foo < [expr $len - 1] } {
4ec70201 754 set str [string range "$string" 0 $foo]
c906108c 755 if { [send_gdb "$str"] != "" } {
4ec70201 756 global suppress_flag
c906108c
SS
757
758 if { ! $suppress_flag } {
4ec70201 759 perror "Couldn't send $command to GDB."
c906108c 760 }
4ec70201 761 fail "$message"
ae59b1da 762 return $result
c906108c 763 }
a0b3c4fd
JM
764 # since we're checking if each line of the multi-line
765 # command are 'accepted' by GDB here,
766 # we need to set -notransfer expect option so that
767 # command output is not lost for pattern matching
768 # - guo
5f279fa6 769 gdb_expect 2 {
543a9323 770 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
5f279fa6 771 timeout { verbose "partial: timeout" 3 }
c906108c 772 }
4ec70201 773 set string [string range "$string" [expr $foo + 1] end]
543a9323 774 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
c906108c 775 } else {
4ec70201 776 break
c906108c
SS
777 }
778 }
779 if { "$string" != "" } {
780 if { [send_gdb "$string"] != "" } {
4ec70201 781 global suppress_flag
c906108c
SS
782
783 if { ! $suppress_flag } {
4ec70201 784 perror "Couldn't send $command to GDB."
c906108c 785 }
4ec70201 786 fail "$message"
ae59b1da 787 return $result
c906108c
SS
788 }
789 }
790 }
791
9d2e1bab 792 if [target_info exists gdb,timeout] {
4ec70201 793 set tmt [target_info gdb,timeout]
c906108c 794 } else {
c906108c 795 if [info exists timeout] {
4ec70201 796 set tmt $timeout
c906108c 797 } else {
4ec70201 798 global timeout
9d2e1bab 799 if [info exists timeout] {
4ec70201 800 set tmt $timeout
9d2e1bab 801 } else {
4ec70201 802 set tmt 60
9d2e1bab 803 }
c906108c
SS
804 }
805 }
2307bd6a
DJ
806
807 set code {
9bfee719
MR
808 -re ".*A problem internal to GDB has been detected" {
809 fail "$message (GDB internal error)"
810 gdb_internal_error_resync
811 }
812 -re "\\*\\*\\* DOSEXIT code.*" {
813 if { $message != "" } {
4ec70201 814 fail "$message"
9bfee719 815 }
4ec70201
PA
816 gdb_suppress_entire_file "GDB died"
817 set result -1
9bfee719 818 }
b0f4b84b
DJ
819 }
820 append code $processed_code
821 append code {
9bfee719 822 -re "Ending remote debugging.*$gdb_prompt $" {
c906108c
SS
823 if ![isnative] then {
824 warning "Can`t communicate to remote target."
825 }
826 gdb_exit
827 gdb_start
828 set result -1
829 }
9bfee719 830 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
c906108c 831 perror "Undefined command \"$command\"."
9bfee719 832 fail "$message"
c906108c
SS
833 set result 1
834 }
9bfee719 835 -re "Ambiguous command.*$gdb_prompt $" {
c906108c 836 perror "\"$command\" is not a unique command name."
9bfee719 837 fail "$message"
c906108c
SS
838 set result 1
839 }
9bfee719 840 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
c906108c 841 if ![string match "" $message] then {
ed4c619a 842 set errmsg "$message (the program exited)"
c906108c 843 } else {
ed4c619a 844 set errmsg "$command (the program exited)"
c906108c
SS
845 }
846 fail "$errmsg"
2307bd6a 847 set result -1
cb9a9d3e 848 }
9bfee719 849 -re "$inferior_exited_re normally.*$gdb_prompt $" {
cb9a9d3e 850 if ![string match "" $message] then {
ed4c619a 851 set errmsg "$message (the program exited)"
cb9a9d3e 852 } else {
ed4c619a 853 set errmsg "$command (the program exited)"
cb9a9d3e
MS
854 }
855 fail "$errmsg"
2307bd6a 856 set result -1
c906108c 857 }
9bfee719 858 -re "The program is not being run.*$gdb_prompt $" {
c906108c 859 if ![string match "" $message] then {
ed4c619a 860 set errmsg "$message (the program is no longer running)"
c906108c 861 } else {
ed4c619a 862 set errmsg "$command (the program is no longer running)"
c906108c
SS
863 }
864 fail "$errmsg"
2307bd6a 865 set result -1
c906108c 866 }
9bfee719 867 -re "\r\n$gdb_prompt $" {
c906108c
SS
868 if ![string match "" $message] then {
869 fail "$message"
870 }
871 set result 1
872 }
9bfee719 873 "<return>" {
c906108c
SS
874 send_gdb "\n"
875 perror "Window too small."
9bfee719 876 fail "$message"
2307bd6a 877 set result -1
c906108c 878 }
b598bfda 879 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
c906108c 880 send_gdb "n\n"
b598bfda
DJ
881 gdb_expect -re "$gdb_prompt $"
882 fail "$message (got interactive prompt)"
883 set result -1
884 }
885 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
886 send_gdb "0\n"
887 gdb_expect -re "$gdb_prompt $"
888 fail "$message (got breakpoint menu)"
2307bd6a 889 set result -1
c906108c 890 }
9bfee719
MR
891 eof {
892 perror "Process no longer exists"
893 if { $message != "" } {
894 fail "$message"
895 }
896 return -1
c906108c 897 }
9bfee719 898 full_buffer {
c906108c 899 perror "internal buffer is full."
9bfee719 900 fail "$message"
2307bd6a 901 set result -1
c906108c
SS
902 }
903 timeout {
904 if ![string match "" $message] then {
905 fail "$message (timeout)"
906 }
907 set result 1
908 }
909 }
2307bd6a
DJ
910
911 set result 0
04f6ecf2
DJ
912 set code [catch {gdb_expect $tmt $code} string]
913 if {$code == 1} {
4ec70201 914 global errorInfo errorCode
04f6ecf2 915 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
d6d7a51a 916 } elseif {$code > 1} {
04f6ecf2
DJ
917 return -code $code $string
918 }
c906108c
SS
919 return $result
920}
2307bd6a
DJ
921
922# gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
923# Send a command to gdb; test the result.
924#
925# COMMAND is the command to execute, send to GDB with send_gdb. If
926# this is the null string no command is sent.
927# PATTERN is the pattern to match for a PASS, and must NOT include
928# the \r\n sequence immediately before the gdb prompt.
929# MESSAGE is an optional message to be printed. If this is
930# omitted, then the pass/fail messages use the command string as the
931# message. (If this is the empty string, then sometimes we don't
932# call pass or fail at all; I don't understand this at all.)
933# QUESTION is a question GDB may ask in response to COMMAND, like
934# "are you sure?"
935# RESPONSE is the response to send if QUESTION appears.
936#
937# Returns:
938# 1 if the test failed,
939# 0 if the test passes,
940# -1 if there was an internal error.
941#
942proc gdb_test { args } {
943 global verbose
944 global gdb_prompt
945 global GDB
946 upvar timeout timeout
947
948 if [llength $args]>2 then {
949 set message [lindex $args 2]
950 } else {
951 set message [lindex $args 0]
952 }
953 set command [lindex $args 0]
954 set pattern [lindex $args 1]
955
956 if [llength $args]==5 {
4ec70201
PA
957 set question_string [lindex $args 3]
958 set response_string [lindex $args 4]
2307bd6a
DJ
959 } else {
960 set question_string "^FOOBAR$"
961 }
962
963 return [gdb_test_multiple $command $message {
964 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
965 if ![string match "" $message] then {
966 pass "$message"
967 }
968 }
969 -re "(${question_string})$" {
4ec70201
PA
970 send_gdb "$response_string\n"
971 exp_continue
2307bd6a
DJ
972 }
973 }]
974}
a7b75dfd
JB
975
976# gdb_test_no_output COMMAND MESSAGE
977# Send a command to GDB and verify that this command generated no output.
978#
979# See gdb_test_multiple for a description of the COMMAND and MESSAGE
980# parameters. If MESSAGE is ommitted, then COMMAND will be used as
c22decce
JB
981# the message. (If MESSAGE is the empty string, then sometimes we do not
982# call pass or fail at all; I don't understand this at all.)
a7b75dfd
JB
983
984proc gdb_test_no_output { args } {
985 global gdb_prompt
986 set command [lindex $args 0]
987 if [llength $args]>1 then {
988 set message [lindex $args 1]
989 } else {
990 set message $command
991 }
992
993 set command_regex [string_to_regexp $command]
994 gdb_test_multiple $command $message {
995 -re "^$command_regex\r\n$gdb_prompt $" {
c22decce
JB
996 if ![string match "" $message] then {
997 pass "$message"
998 }
a7b75dfd
JB
999 }
1000 }
1001}
1002
6b0ecdc2
DE
1003# Send a command and then wait for a sequence of outputs.
1004# This is useful when the sequence is long and contains ".*", a single
1005# regexp to match the entire output can get a timeout much easier.
1006#
1007# COMMAND is the command to send.
1008# TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1009# EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1010# processed in order, and all must be present in the output.
1011#
1012# It is unnecessary to specify ".*" at the beginning or end of any regexp,
1013# there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1014# There is also an implicit ".*" between the last regexp and the gdb prompt.
1015#
1016# Like gdb_test and gdb_test_multiple, the output is expected to end with the
1017# gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
5fa290c1
DE
1018#
1019# Returns:
1020# 1 if the test failed,
1021# 0 if the test passes,
1022# -1 if there was an internal error.
6b0ecdc2
DE
1023
1024proc gdb_test_sequence { command test_name expected_output_list } {
1025 global gdb_prompt
1026 if { $test_name == "" } {
1027 set test_name $command
1028 }
1029 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1030 send_gdb "$command\n"
5fa290c1 1031 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
6b0ecdc2
DE
1032}
1033
c906108c
SS
1034\f
1035# Test that a command gives an error. For pass or fail, return
1036# a 1 to indicate that more tests can proceed. However a timeout
1037# is a serious error, generates a special fail message, and causes
1038# a 0 to be returned to indicate that more tests are likely to fail
1039# as well.
1040
1041proc test_print_reject { args } {
1042 global gdb_prompt
1043 global verbose
1044
1045 if [llength $args]==2 then {
1046 set expectthis [lindex $args 1]
1047 } else {
1048 set expectthis "should never match this bogus string"
1049 }
1050 set sendthis [lindex $args 0]
1051 if $verbose>2 then {
1052 send_user "Sending \"$sendthis\" to gdb\n"
1053 send_user "Looking to match \"$expectthis\"\n"
1054 }
1055 send_gdb "$sendthis\n"
1056 #FIXME: Should add timeout as parameter.
1057 gdb_expect {
1058 -re "A .* in expression.*\\.*$gdb_prompt $" {
1059 pass "reject $sendthis"
1060 return 1
1061 }
1062 -re "Invalid syntax in expression.*$gdb_prompt $" {
1063 pass "reject $sendthis"
1064 return 1
1065 }
1066 -re "Junk after end of expression.*$gdb_prompt $" {
1067 pass "reject $sendthis"
1068 return 1
1069 }
1070 -re "Invalid number.*$gdb_prompt $" {
1071 pass "reject $sendthis"
1072 return 1
1073 }
1074 -re "Invalid character constant.*$gdb_prompt $" {
1075 pass "reject $sendthis"
1076 return 1
1077 }
1078 -re "No symbol table is loaded.*$gdb_prompt $" {
1079 pass "reject $sendthis"
1080 return 1
1081 }
1082 -re "No symbol .* in current context.*$gdb_prompt $" {
1083 pass "reject $sendthis"
1084 return 1
1085 }
c4b7bc2b
JB
1086 -re "Unmatched single quote.*$gdb_prompt $" {
1087 pass "reject $sendthis"
1088 return 1
1089 }
1090 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1091 pass "reject $sendthis"
1092 return 1
1093 }
c906108c
SS
1094 -re "$expectthis.*$gdb_prompt $" {
1095 pass "reject $sendthis"
1096 return 1
1097 }
1098 -re ".*$gdb_prompt $" {
1099 fail "reject $sendthis"
1100 return 1
1101 }
1102 default {
1103 fail "reject $sendthis (eof or timeout)"
1104 return 0
1105 }
1106 }
1107}
1108\f
1109# Given an input string, adds backslashes as needed to create a
1110# regexp that will match the string.
1111
1112proc string_to_regexp {str} {
1113 set result $str
39fb8e9e 1114 regsub -all {[]*+.|()^$\[\\]} $str {\\&} result
c906108c
SS
1115 return $result
1116}
1117
1118# Same as gdb_test, but the second parameter is not a regexp,
1119# but a string that must match exactly.
1120
1121proc gdb_test_exact { args } {
1122 upvar timeout timeout
1123
1124 set command [lindex $args 0]
1125
1126 # This applies a special meaning to a null string pattern. Without
1127 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1128 # messages from commands that should have no output except a new
1129 # prompt. With this, only results of a null string will match a null
1130 # string pattern.
1131
1132 set pattern [lindex $args 1]
1133 if [string match $pattern ""] {
1134 set pattern [string_to_regexp [lindex $args 0]]
1135 } else {
1136 set pattern [string_to_regexp [lindex $args 1]]
1137 }
1138
1139 # It is most natural to write the pattern argument with only
1140 # embedded \n's, especially if you are trying to avoid Tcl quoting
1141 # problems. But gdb_expect really wants to see \r\n in patterns. So
1142 # transform the pattern here. First transform \r\n back to \n, in
1143 # case some users of gdb_test_exact already do the right thing.
1144 regsub -all "\r\n" $pattern "\n" pattern
1145 regsub -all "\n" $pattern "\r\n" pattern
1146 if [llength $args]==3 then {
1147 set message [lindex $args 2]
1148 } else {
1149 set message $command
1150 }
1151
1152 return [gdb_test $command $pattern $message]
1153}
2dfb8c17
DE
1154
1155# Wrapper around gdb_test_multiple that looks for a list of expected
1156# output elements, but which can appear in any order.
1157# CMD is the gdb command.
1158# NAME is the name of the test.
1159# ELM_FIND_REGEXP specifies how to partition the output into elements to
1160# compare.
1161# ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1162# RESULT_MATCH_LIST is a list of exact matches for each expected element.
1163# All elements of RESULT_MATCH_LIST must appear for the test to pass.
1164#
1165# A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1166# of text per element and then strip trailing \r\n's.
1167# Example:
1168# gdb_test_list_exact "foo" "bar" \
eec52c44
PM
1169# "\[^\r\n\]+\[\r\n\]+" \
1170# "\[^\r\n\]+" \
2dfb8c17
DE
1171# { \
1172# {expected result 1} \
1173# {expected result 2} \
1174# }
1175
1176proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1177 global gdb_prompt
1178
1179 set matches [lsort $result_match_list]
1180 set seen {}
1181 gdb_test_multiple $cmd $name {
1182 "$cmd\[\r\n\]" { exp_continue }
1183 -re $elm_find_regexp {
1184 set str $expect_out(0,string)
1185 verbose -log "seen: $str" 3
1186 regexp -- $elm_extract_regexp $str elm_seen
1187 verbose -log "extracted: $elm_seen" 3
1188 lappend seen $elm_seen
1189 exp_continue
1190 }
1191 -re "$gdb_prompt $" {
1192 set failed ""
1193 foreach got [lsort $seen] have $matches {
1194 if {![string equal $got $have]} {
1195 set failed $have
1196 break
1197 }
1198 }
1199 if {[string length $failed] != 0} {
1200 fail "$name ($failed not found)"
1201 } else {
1202 pass $name
1203 }
1204 }
1205 }
1206}
c906108c 1207\f
bd293940
PA
1208
1209# Issue a PASS and return true if evaluating CONDITION in the caller's
1210# frame returns true, and issue a FAIL and return false otherwise.
1211# MESSAGE is the pass/fail message to be printed. If MESSAGE is
1212# omitted or is empty, then the pass/fail messages use the condition
1213# string as the message.
1214
1215proc gdb_assert { condition {message ""} } {
1216 if { $message == ""} {
1217 set message $condition
1218 }
1219
1220 set res [uplevel 1 expr $condition]
1221 if {!$res} {
1222 fail $message
1223 } else {
1224 pass $message
1225 }
1226 return $res
1227}
1228
c906108c
SS
1229proc gdb_reinitialize_dir { subdir } {
1230 global gdb_prompt
1231
1232 if [is_remote host] {
ae59b1da 1233 return ""
c906108c
SS
1234 }
1235 send_gdb "dir\n"
1236 gdb_expect 60 {
1237 -re "Reinitialize source path to empty.*y or n. " {
1238 send_gdb "y\n"
1239 gdb_expect 60 {
1240 -re "Source directories searched.*$gdb_prompt $" {
1241 send_gdb "dir $subdir\n"
1242 gdb_expect 60 {
1243 -re "Source directories searched.*$gdb_prompt $" {
1244 verbose "Dir set to $subdir"
1245 }
1246 -re "$gdb_prompt $" {
1247 perror "Dir \"$subdir\" failed."
1248 }
1249 }
1250 }
1251 -re "$gdb_prompt $" {
1252 perror "Dir \"$subdir\" failed."
1253 }
1254 }
1255 }
1256 -re "$gdb_prompt $" {
1257 perror "Dir \"$subdir\" failed."
1258 }
1259 }
1260}
1261
1262#
1263# gdb_exit -- exit the GDB, killing the target program if necessary
1264#
1265proc default_gdb_exit {} {
1266 global GDB
6b8ce727 1267 global INTERNAL_GDBFLAGS GDBFLAGS
c906108c 1268 global verbose
4ec70201 1269 global gdb_spawn_id
5e92f71a 1270 global inotify_log_file
c906108c 1271
4ec70201 1272 gdb_stop_suppressing_tests
c906108c
SS
1273
1274 if ![info exists gdb_spawn_id] {
4ec70201 1275 return
c906108c
SS
1276 }
1277
6b8ce727 1278 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
c906108c 1279
5e92f71a
TT
1280 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1281 set fd [open $inotify_log_file]
1282 set data [read -nonewline $fd]
1283 close $fd
1284
1285 if {[string compare $data ""] != 0} {
1286 warning "parallel-unsafe file creations noticed"
1287
1288 # Clear the log.
1289 set fd [open $inotify_log_file w]
1290 close $fd
1291 }
1292 }
1293
c906108c 1294 if { [is_remote host] && [board_info host exists fileid] } {
4ec70201 1295 send_gdb "quit\n"
c906108c
SS
1296 gdb_expect 10 {
1297 -re "y or n" {
4ec70201
PA
1298 send_gdb "y\n"
1299 exp_continue
c906108c
SS
1300 }
1301 -re "DOSEXIT code" { }
1302 default { }
1303 }
1304 }
1305
1306 if ![is_remote host] {
4ec70201 1307 remote_close host
c906108c
SS
1308 }
1309 unset gdb_spawn_id
1310}
1311
3e3ffd2b 1312# Load a file into the debugger.
2db8e78e 1313# The return value is 0 for success, -1 for failure.
c906108c 1314#
2db8e78e
MC
1315# This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1316# to one of these values:
3e3ffd2b 1317#
2db8e78e
MC
1318# debug file was loaded successfully and has debug information
1319# nodebug file was loaded successfully and has no debug information
608e2dbb
TT
1320# lzma file was loaded, .gnu_debugdata found, but no LZMA support
1321# compiled in
2db8e78e 1322# fail file was not loaded
c906108c 1323#
2db8e78e
MC
1324# I tried returning this information as part of the return value,
1325# but ran into a mess because of the many re-implementations of
1326# gdb_load in config/*.exp.
3e3ffd2b 1327#
2db8e78e
MC
1328# TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1329# this if they can get more information set.
3e3ffd2b 1330
c906108c 1331proc gdb_file_cmd { arg } {
3e3ffd2b 1332 global gdb_prompt
c906108c 1333 global verbose
c906108c 1334 global GDB
b741e217
DJ
1335 global last_loaded_file
1336
975531db 1337 # Save this for the benefit of gdbserver-support.exp.
b741e217 1338 set last_loaded_file $arg
c906108c 1339
2db8e78e
MC
1340 # Set whether debug info was found.
1341 # Default to "fail".
1342 global gdb_file_cmd_debug_info
1343 set gdb_file_cmd_debug_info "fail"
1344
c906108c 1345 if [is_remote host] {
3e3ffd2b 1346 set arg [remote_download host $arg]
c906108c 1347 if { $arg == "" } {
2db8e78e
MC
1348 perror "download failed"
1349 return -1
c906108c
SS
1350 }
1351 }
1352
4c42eaff
DJ
1353 # The file command used to kill the remote target. For the benefit
1354 # of the testsuite, preserve this behavior.
1355 send_gdb "kill\n"
1356 gdb_expect 120 {
1357 -re "Kill the program being debugged. .y or n. $" {
1358 send_gdb "y\n"
1359 verbose "\t\tKilling previous program being debugged"
1360 exp_continue
1361 }
1362 -re "$gdb_prompt $" {
1363 # OK.
1364 }
1365 }
1366
c906108c
SS
1367 send_gdb "file $arg\n"
1368 gdb_expect 120 {
608e2dbb
TT
1369 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1370 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1371 set gdb_file_cmd_debug_info "lzma"
1372 return 0
1373 }
3e3ffd2b 1374 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
975531db 1375 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
2db8e78e
MC
1376 set gdb_file_cmd_debug_info "nodebug"
1377 return 0
3e3ffd2b 1378 }
c906108c 1379 -re "Reading symbols from.*done.*$gdb_prompt $" {
975531db 1380 verbose "\t\tLoaded $arg into $GDB"
2db8e78e
MC
1381 set gdb_file_cmd_debug_info "debug"
1382 return 0
c906108c 1383 }
c906108c
SS
1384 -re "Load new symbol table from \".*\".*y or n. $" {
1385 send_gdb "y\n"
1386 gdb_expect 120 {
1387 -re "Reading symbols from.*done.*$gdb_prompt $" {
1388 verbose "\t\tLoaded $arg with new symbol table into $GDB"
2db8e78e
MC
1389 set gdb_file_cmd_debug_info "debug"
1390 return 0
c906108c
SS
1391 }
1392 timeout {
975531db 1393 perror "Couldn't load $arg, other program already loaded (timeout)."
2db8e78e 1394 return -1
c906108c 1395 }
975531db
DE
1396 eof {
1397 perror "Couldn't load $arg, other program already loaded (eof)."
1398 return -1
1399 }
c906108c
SS
1400 }
1401 }
1402 -re "No such file or directory.*$gdb_prompt $" {
2db8e78e
MC
1403 perror "($arg) No such file or directory"
1404 return -1
c906108c 1405 }
04e7407c 1406 -re "A problem internal to GDB has been detected" {
5b7d0050 1407 fail "($arg) (GDB internal error)"
04e7407c
JK
1408 gdb_internal_error_resync
1409 return -1
1410 }
c906108c 1411 -re "$gdb_prompt $" {
975531db 1412 perror "Couldn't load $arg into $GDB."
2db8e78e 1413 return -1
c906108c
SS
1414 }
1415 timeout {
975531db 1416 perror "Couldn't load $arg into $GDB (timeout)."
2db8e78e 1417 return -1
c906108c
SS
1418 }
1419 eof {
1420 # This is an attempt to detect a core dump, but seems not to
1421 # work. Perhaps we need to match .* followed by eof, in which
1422 # gdb_expect does not seem to have a way to do that.
975531db 1423 perror "Couldn't load $arg into $GDB (eof)."
2db8e78e 1424 return -1
c906108c
SS
1425 }
1426 }
1427}
1428
1429#
1430# start gdb -- start gdb running, default procedure
1431#
1432# When running over NFS, particularly if running many simultaneous
1433# tests on different hosts all using the same server, things can
1434# get really slow. Give gdb at least 3 minutes to start up.
1435#
1436proc default_gdb_start { } {
e11ac3a3 1437 global verbose use_gdb_stub
c906108c 1438 global GDB
6b8ce727 1439 global INTERNAL_GDBFLAGS GDBFLAGS
c906108c
SS
1440 global gdb_prompt
1441 global timeout
4ec70201 1442 global gdb_spawn_id
c906108c 1443
4ec70201 1444 gdb_stop_suppressing_tests
c906108c 1445
e11ac3a3
JK
1446 # Set the default value, it may be overriden later by specific testfile.
1447 #
1448 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1449 # is already started after connecting and run/attach are not supported.
1450 # This is used for the "remote" protocol. After GDB starts you should
1451 # check global $use_gdb_stub instead of the board as the testfile may force
1452 # a specific different target protocol itself.
1453 set use_gdb_stub [target_info exists use_gdb_stub]
1454
6b8ce727 1455 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
c906108c
SS
1456
1457 if [info exists gdb_spawn_id] {
ae59b1da 1458 return 0
c906108c
SS
1459 }
1460
1461 if ![is_remote host] {
1462 if { [which $GDB] == 0 } then {
1463 perror "$GDB does not exist."
1464 exit 1
1465 }
1466 }
4ec70201 1467 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
c906108c
SS
1468 if { $res < 0 || $res == "" } {
1469 perror "Spawning $GDB failed."
ae59b1da 1470 return 1
c906108c
SS
1471 }
1472 gdb_expect 360 {
1473 -re "\[\r\n\]$gdb_prompt $" {
1474 verbose "GDB initialized."
1475 }
1476 -re "$gdb_prompt $" {
1477 perror "GDB never initialized."
1478 return -1
1479 }
1480 timeout {
1481 perror "(timeout) GDB never initialized after 10 seconds."
4ec70201 1482 remote_close host
c906108c
SS
1483 return -1
1484 }
1485 }
4ec70201 1486 set gdb_spawn_id -1
c906108c
SS
1487 # force the height to "unlimited", so no pagers get used
1488
1489 send_gdb "set height 0\n"
1490 gdb_expect 10 {
1491 -re "$gdb_prompt $" {
1492 verbose "Setting height to 0." 2
1493 }
1494 timeout {
1495 warning "Couldn't set the height to 0"
1496 }
1497 }
1498 # force the width to "unlimited", so no wraparound occurs
1499 send_gdb "set width 0\n"
1500 gdb_expect 10 {
1501 -re "$gdb_prompt $" {
1502 verbose "Setting width to 0." 2
1503 }
1504 timeout {
1505 warning "Couldn't set the width to 0."
1506 }
1507 }
ae59b1da 1508 return 0
c906108c
SS
1509}
1510
ec3c07fc
NS
1511# Examine the output of compilation to determine whether compilation
1512# failed or not. If it failed determine whether it is due to missing
1513# compiler or due to compiler error. Report pass, fail or unsupported
1514# as appropriate
1515
1516proc gdb_compile_test {src output} {
1517 if { $output == "" } {
1518 pass "compilation [file tail $src]"
1519 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1520 unsupported "compilation [file tail $src]"
1521 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1522 unsupported "compilation [file tail $src]"
6bb85cd1
DE
1523 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1524 unsupported "compilation [file tail $src]"
ec3c07fc
NS
1525 } else {
1526 verbose -log "compilation failed: $output" 2
1527 fail "compilation [file tail $src]"
1528 }
1529}
1530
d4f3574e
SS
1531# Return a 1 for configurations for which we don't even want to try to
1532# test C++.
1533
1534proc skip_cplus_tests {} {
d4f3574e
SS
1535 if { [istarget "h8300-*-*"] } {
1536 return 1
1537 }
81d2cbae 1538
1146c7f1
SC
1539 # The C++ IO streams are too large for HC11/HC12 and are thus not
1540 # available. The gdb C++ tests use them and don't compile.
1541 if { [istarget "m6811-*-*"] } {
1542 return 1
1543 }
1544 if { [istarget "m6812-*-*"] } {
1545 return 1
1546 }
d4f3574e
SS
1547 return 0
1548}
1549
759f0f0b
PA
1550# Return a 1 for configurations for which don't have both C++ and the STL.
1551
1552proc skip_stl_tests {} {
1553 # Symbian supports the C++ language, but the STL is missing
1554 # (both headers and libraries).
1555 if { [istarget "arm*-*-symbianelf*"] } {
1556 return 1
1557 }
1558
1559 return [skip_cplus_tests]
1560}
1561
89a237cb
MC
1562# Return a 1 if I don't even want to try to test FORTRAN.
1563
1564proc skip_fortran_tests {} {
1565 return 0
1566}
1567
ec3c07fc
NS
1568# Return a 1 if I don't even want to try to test ada.
1569
1570proc skip_ada_tests {} {
1571 return 0
1572}
1573
a766d390
DE
1574# Return a 1 if I don't even want to try to test GO.
1575
1576proc skip_go_tests {} {
1577 return 0
1578}
1579
ec3c07fc
NS
1580# Return a 1 if I don't even want to try to test java.
1581
1582proc skip_java_tests {} {
1583 return 0
1584}
1585
7f420862
IB
1586# Return a 1 if I don't even want to try to test D.
1587
1588proc skip_d_tests {} {
1589 return 0
1590}
1591
f6bbabf0
PM
1592# Return a 1 for configurations that do not support Python scripting.
1593
1594proc skip_python_tests {} {
1595 global gdb_prompt
9325cb04
PK
1596 global gdb_py_is_py3k
1597 global gdb_py_is_py24
1598
1599 gdb_test_multiple "python print ('test')" "verify python support" {
f6bbabf0
PM
1600 -re "not supported.*$gdb_prompt $" {
1601 unsupported "Python support is disabled."
1602 return 1
1603 }
1604 -re "$gdb_prompt $" {}
1605 }
1606
9325cb04
PK
1607 set gdb_py_is_py24 0
1608 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1609 -re "3.*$gdb_prompt $" {
1610 set gdb_py_is_py3k 1
1611 }
1612 -re ".*$gdb_prompt $" {
1613 set gdb_py_is_py3k 0
1614 }
1615 }
1616 if { $gdb_py_is_py3k == 0 } {
1617 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1618 -re "\[45\].*$gdb_prompt $" {
1619 set gdb_py_is_py24 1
1620 }
1621 -re ".*$gdb_prompt $" {
1622 set gdb_py_is_py24 0
1623 }
1624 }
1625 }
1626
f6bbabf0
PM
1627 return 0
1628}
1629
93f02886
DJ
1630# Return a 1 if we should skip shared library tests.
1631
1632proc skip_shlib_tests {} {
1633 # Run the shared library tests on native systems.
1634 if {[isnative]} {
1635 return 0
1636 }
1637
1638 # An abbreviated list of remote targets where we should be able to
1639 # run shared library tests.
1640 if {([istarget *-*-linux*]
1641 || [istarget *-*-*bsd*]
1642 || [istarget *-*-solaris2*]
1643 || [istarget arm*-*-symbianelf*]
1644 || [istarget *-*-mingw*]
1645 || [istarget *-*-cygwin*]
1646 || [istarget *-*-pe*])} {
1647 return 0
1648 }
1649
1650 return 1
1651}
1652
6a5870ce
PA
1653# Test files shall make sure all the test result lines in gdb.sum are
1654# unique in a test run, so that comparing the gdb.sum files of two
1655# test runs gives correct results. Test files that exercise
1656# variations of the same tests more than once, shall prefix the
1657# different test invocations with different identifying strings in
1658# order to make them unique.
1659#
1660# About test prefixes:
1661#
1662# $pf_prefix is the string that dejagnu prints after the result (FAIL,
1663# PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1664# underlined substring in
1665#
1666# PASS: gdb.base/mytest.exp: some test
1667# ^^^^^^^^^^^^^^^^^^^^
1668#
1669# is $pf_prefix.
1670#
1671# The easiest way to adjust the test prefix is to append a test
1672# variation prefix to the $pf_prefix, using the with_test_prefix
1673# procedure. E.g.,
1674#
1675# proc do_tests {} {
1676# gdb_test ... ... "test foo"
1677# gdb_test ... ... "test bar"
1678#
0f4d39d5 1679# with_test_prefix "subvariation a" {
6a5870ce
PA
1680# gdb_test ... ... "test x"
1681# }
1682#
0f4d39d5 1683# with_test_prefix "subvariation b" {
6a5870ce
PA
1684# gdb_test ... ... "test x"
1685# }
1686# }
1687#
0f4d39d5 1688# with_test_prefix "variation1" {
6a5870ce
PA
1689# ...do setup for variation 1...
1690# do_tests
1691# }
1692#
0f4d39d5 1693# with_test_prefix "variation2" {
6a5870ce
PA
1694# ...do setup for variation 2...
1695# do_tests
1696# }
1697#
1698# Results in:
1699#
1700# PASS: gdb.base/mytest.exp: variation1: test foo
1701# PASS: gdb.base/mytest.exp: variation1: test bar
1702# PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1703# PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1704# PASS: gdb.base/mytest.exp: variation2: test foo
1705# PASS: gdb.base/mytest.exp: variation2: test bar
1706# PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1707# PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1708#
1709# If for some reason more flexibility is necessary, one can also
1710# manipulate the pf_prefix global directly, treating it as a string.
1711# E.g.,
1712#
1713# global pf_prefix
1714# set saved_pf_prefix
0f4d39d5 1715# append pf_prefix "${foo}: bar"
6a5870ce
PA
1716# ... actual tests ...
1717# set pf_prefix $saved_pf_prefix
1718#
1719
1720# Run BODY in the context of the caller, with the current test prefix
0f4d39d5
PA
1721# (pf_prefix) appended with one space, then PREFIX, and then a colon.
1722# Returns the result of BODY.
6a5870ce
PA
1723#
1724proc with_test_prefix { prefix body } {
1725 global pf_prefix
1726
1727 set saved $pf_prefix
0f4d39d5 1728 append pf_prefix " " $prefix ":"
6a5870ce
PA
1729 set code [catch {uplevel 1 $body} result]
1730 set pf_prefix $saved
1731
1732 if {$code == 1} {
1733 global errorInfo errorCode
1734 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1735 } else {
1736 return -code $code $result
1737 }
1738}
1739
8b5e6dc2
YQ
1740# Run tests in BODY with GDB prompt and variable $gdb_prompt set to
1741# PROMPT. When BODY is finished, restore GDB prompt and variable
1742# $gdb_prompt.
1743# Returns the result of BODY.
1744
1745proc with_gdb_prompt { prompt body } {
1746 global gdb_prompt
1747
1748 set saved $gdb_prompt
1749
1750 set gdb_prompt $prompt
1751 gdb_test_no_output "set prompt $prompt " ""
1752
1753 set code [catch {uplevel 1 $body} result]
1754
1755 set gdb_prompt $saved
1756 gdb_test_no_output "set prompt $saved " ""
1757
1758 if {$code == 1} {
1759 global errorInfo errorCode
1760 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1761 } else {
1762 return -code $code $result
1763 }
1764}
1765
389b98f7
YQ
1766# Run tests in BODY with target-charset setting to TARGET_CHARSET. When
1767# BODY is finished, restore target-charset.
1768
1769proc with_target_charset { target_charset body } {
1770 global gdb_prompt
1771
1772 set saved ""
1773 gdb_test_multiple "show target-charset" "" {
1774 -re "The target character set is \".*; currently (.*)\"\..*$gdb_prompt " {
1775 set saved $expect_out(1,string)
1776 }
1777 -re "The target character set is \"(.*)\".*$gdb_prompt " {
1778 set saved $expect_out(1,string)
1779 }
1780 -re ".*$gdb_prompt " {
1781 fail "get target-charset"
1782 }
1783 }
1784
1785 gdb_test_no_output "set target-charset $target_charset" ""
1786
1787 set code [catch {uplevel 1 $body} result]
1788
1789 gdb_test_no_output "set target-charset $saved" ""
1790
1791 if {$code == 1} {
1792 global errorInfo errorCode
1793 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1794 } else {
1795 return -code $code $result
1796 }
1797}
1798
e43ec454
YQ
1799# Return 1 if _Complex types are supported, otherwise, return 0.
1800
17e1c970 1801gdb_caching_proc support_complex_tests {
e43ec454
YQ
1802 # Set up, compile, and execute a test program containing _Complex types.
1803 # Include the current process ID in the file names to prevent conflicts
1804 # with invocations for multiple testsuites.
4e234898
TT
1805 set src [standard_temp_file complex[pid].c]
1806 set exe [standard_temp_file complex[pid].x]
e43ec454 1807
11ec5965
YQ
1808 gdb_produce_source $src {
1809 int main() {
1810 _Complex float cf;
1811 _Complex double cd;
1812 _Complex long double cld;
1813 return 0;
1814 }
1815 }
e43ec454
YQ
1816
1817 verbose "compiling testfile $src" 2
1818 set compile_flags {debug nowarnings quiet}
1819 set lines [gdb_compile $src $exe executable $compile_flags]
1820 file delete $src
1821 file delete $exe
1822
1823 if ![string match "" $lines] then {
1824 verbose "testfile compilation failed, returning 0" 2
17e1c970 1825 set result 0
e43ec454 1826 } else {
17e1c970 1827 set result 1
e43ec454
YQ
1828 }
1829
17e1c970 1830 return $result
e43ec454
YQ
1831}
1832
ab254057
YQ
1833# Return 1 if target hardware or OS supports single stepping to signal
1834# handler, otherwise, return 0.
1835
1836proc can_single_step_to_signal_handler {} {
1837
1838 # Targets don't have hardware single step. On these targets, when
1839 # a signal is delivered during software single step, gdb is unable
1840 # to determine the next instruction addresses, because start of signal
1841 # handler is one of them.
b0221781 1842 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
b5bee914
YQ
1843 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"]
1844 || [istarget "nios2-*-*"] } {
ab254057
YQ
1845 return 0
1846 }
1847
1848 return 1
1849}
1850
d3895d7d
YQ
1851# Return 1 if target supports process record, otherwise return 0.
1852
1853proc supports_process_record {} {
1854
1855 if [target_info exists gdb,use_precord] {
1856 return [target_info gdb,use_precord]
1857 }
1858
596662fa
OJ
1859 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
1860 || [istarget "i\[34567\]86-*-linux*"] } {
d3895d7d
YQ
1861 return 1
1862 }
1863
1864 return 0
1865}
1866
1867# Return 1 if target supports reverse debugging, otherwise return 0.
1868
1869proc supports_reverse {} {
1870
1871 if [target_info exists gdb,can_reverse] {
1872 return [target_info gdb,can_reverse]
1873 }
1874
596662fa
OJ
1875 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
1876 || [istarget "i\[34567\]86-*-linux*"] } {
d3895d7d
YQ
1877 return 1
1878 }
1879
1880 return 0
1881}
1882
0d4d0e77
YQ
1883# Return 1 if readline library is used.
1884
1885proc readline_is_used { } {
1886 global gdb_prompt
1887
1888 gdb_test_multiple "show editing" "" {
1889 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
1890 return 1
1891 }
1892 -re ".*$gdb_prompt $" {
1893 return 0
1894 }
1895 }
1896}
1897
e9f0e62e
NB
1898# Return 1 if target is ELF.
1899gdb_caching_proc is_elf_target {
1900 set me "is_elf_target"
1901
1902 set src [standard_temp_file is_elf_target[pid].c]
1903 set obj [standard_temp_file is_elf_target[pid].o]
1904
11ec5965
YQ
1905 gdb_produce_source $src {
1906 int foo () {return 0;}
1907 }
e9f0e62e
NB
1908
1909 verbose "$me: compiling testfile $src" 2
1910 set lines [gdb_compile $src $obj object {quiet}]
1911
1912 file delete $src
1913
1914 if ![string match "" $lines] then {
1915 verbose "$me: testfile compilation failed, returning 0" 2
1916 return 0
1917 }
1918
1919 set fp_obj [open $obj "r"]
1920 fconfigure $fp_obj -translation binary
1921 set data [read $fp_obj]
1922 close $fp_obj
1923
1924 file delete $obj
1925
1926 set ELFMAG "\u007FELF"
1927
1928 if {[string compare -length 4 $data $ELFMAG] != 0} {
1929 verbose "$me: returning 0" 2
1930 return 0
1931 }
1932
1933 verbose "$me: returning 1" 2
1934 return 1
1935}
1936
6dbb6798
YQ
1937# Produce source file NAME and write SOURCES into it.
1938
1939proc gdb_produce_source { name sources } {
1940 set index 0
1941 set f [open $name "w"]
1942
1943 puts $f $sources
1944 close $f
1945}
1946
add265ae
L
1947# Return 1 if target is ILP32.
1948# This cannot be decided simply from looking at the target string,
1949# as it might depend on externally passed compiler options like -m64.
17e1c970 1950gdb_caching_proc is_ilp32_target {
add265ae 1951 set me "is_ilp32_target"
add265ae 1952
4e234898
TT
1953 set src [standard_temp_file ilp32[pid].c]
1954 set obj [standard_temp_file ilp32[pid].o]
add265ae 1955
11ec5965
YQ
1956 gdb_produce_source $src {
1957 int dummy[sizeof (int) == 4
1958 && sizeof (void *) == 4
1959 && sizeof (long) == 4 ? 1 : -1];
1960 }
add265ae
L
1961
1962 verbose "$me: compiling testfile $src" 2
1963 set lines [gdb_compile $src $obj object {quiet}]
1964 file delete $src
1965 file delete $obj
1966
1967 if ![string match "" $lines] then {
1968 verbose "$me: testfile compilation failed, returning 0" 2
17e1c970 1969 return 0
add265ae
L
1970 }
1971
1972 verbose "$me: returning 1" 2
17e1c970 1973 return 1
add265ae
L
1974}
1975
1976# Return 1 if target is LP64.
1977# This cannot be decided simply from looking at the target string,
1978# as it might depend on externally passed compiler options like -m64.
17e1c970 1979gdb_caching_proc is_lp64_target {
add265ae 1980 set me "is_lp64_target"
add265ae 1981
4e234898
TT
1982 set src [standard_temp_file lp64[pid].c]
1983 set obj [standard_temp_file lp64[pid].o]
add265ae 1984
11ec5965
YQ
1985 gdb_produce_source $src {
1986 int dummy[sizeof (int) == 4
1987 && sizeof (void *) == 8
1988 && sizeof (long) == 8 ? 1 : -1];
1989 }
add265ae
L
1990
1991 verbose "$me: compiling testfile $src" 2
1992 set lines [gdb_compile $src $obj object {quiet}]
1993 file delete $src
1994 file delete $obj
1995
1996 if ![string match "" $lines] then {
1997 verbose "$me: testfile compilation failed, returning 0" 2
17e1c970 1998 return 0
add265ae
L
1999 }
2000
2001 verbose "$me: returning 1" 2
17e1c970 2002 return 1
add265ae
L
2003}
2004
e630b974
TT
2005# Return 1 if target has 64 bit addresses.
2006# This cannot be decided simply from looking at the target string,
2007# as it might depend on externally passed compiler options like -m64.
2008gdb_caching_proc is_64_target {
2009 set me "is_64_target"
2010
2011 set src [standard_temp_file is64[pid].c]
2012 set obj [standard_temp_file is64[pid].o]
2013
11ec5965
YQ
2014 gdb_produce_source $src {
2015 int function(void) { return 3; }
2016 int dummy[sizeof (&function) == 8 ? 1 : -1];
2017 }
e630b974
TT
2018
2019 verbose "$me: compiling testfile $src" 2
2020 set lines [gdb_compile $src $obj object {quiet}]
2021 file delete $src
2022 file delete $obj
2023
2024 if ![string match "" $lines] then {
2025 verbose "$me: testfile compilation failed, returning 0" 2
2026 return 0
2027 }
2028
2029 verbose "$me: returning 1" 2
2030 return 1
2031}
2032
7f062217
JK
2033# Return 1 if target has x86_64 registers - either amd64 or x32.
2034# x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2035# just from the target string.
17e1c970 2036gdb_caching_proc is_amd64_regs_target {
68fb0ec0 2037 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
7f062217
JK
2038 return 0
2039 }
2040
7f062217 2041 set me "is_amd64_regs_target"
7f062217 2042
4e234898
TT
2043 set src [standard_temp_file reg64[pid].s]
2044 set obj [standard_temp_file reg64[pid].o]
7f062217 2045
11ec5965 2046 set list {}
7f062217 2047 foreach reg \
11ec5965
YQ
2048 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
2049 lappend list "\tincq %$reg"
2050 }
2051 gdb_produce_source $src [join $list \n]
7f062217
JK
2052
2053 verbose "$me: compiling testfile $src" 2
2054 set lines [gdb_compile $src $obj object {quiet}]
2055 file delete $src
2056 file delete $obj
2057
2058 if ![string match "" $lines] then {
2059 verbose "$me: testfile compilation failed, returning 0" 2
17e1c970 2060 return 0
7f062217
JK
2061 }
2062
2063 verbose "$me: returning 1" 2
17e1c970 2064 return 1
7f062217
JK
2065}
2066
6edba76f
TT
2067# Return 1 if this target is an x86 or x86-64 with -m32.
2068proc is_x86_like_target {} {
68fb0ec0 2069 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
6edba76f
TT
2070 return 0
2071 }
7f062217 2072 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
6edba76f
TT
2073}
2074
be777e08
YQ
2075# Return 1 if displaced stepping is supported on target, otherwise, return 0.
2076proc support_displaced_stepping {} {
2077
2078 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2079 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2080 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"] } {
2081 return 1
2082 }
2083
2084 return 0
2085}
2086
3c95e6af
PG
2087# Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2088# 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2089
17e1c970 2090gdb_caching_proc skip_altivec_tests {
fda326dd 2091 global srcdir subdir gdb_prompt inferior_exited_re
3c95e6af 2092
3c95e6af 2093 set me "skip_altivec_tests"
3c95e6af
PG
2094
2095 # Some simulators are known to not support VMX instructions.
2096 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2097 verbose "$me: target known to not support VMX, returning 1" 2
17e1c970 2098 return 1
3c95e6af
PG
2099 }
2100
2101 # Make sure we have a compiler that understands altivec.
fc91c6c2 2102 set compile_flags {debug nowarnings}
4c93b1db 2103 if [get_compiler_info] {
3c95e6af
PG
2104 warning "Could not get compiler info"
2105 return 1
2106 }
2107 if [test_compiler_info gcc*] {
2108 set compile_flags "$compile_flags additional_flags=-maltivec"
2109 } elseif [test_compiler_info xlc*] {
2110 set compile_flags "$compile_flags additional_flags=-qaltivec"
2111 } else {
2112 verbose "Could not compile with altivec support, returning 1" 2
2113 return 1
2114 }
2115
2116 # Set up, compile, and execute a test program containing VMX instructions.
2117 # Include the current process ID in the file names to prevent conflicts
2118 # with invocations for multiple testsuites.
4e234898
TT
2119 set src [standard_temp_file vmx[pid].c]
2120 set exe [standard_temp_file vmx[pid].x]
3c95e6af 2121
11ec5965
YQ
2122 gdb_produce_source $src {
2123 int main() {
2124 #ifdef __MACH__
2125 asm volatile ("vor v0,v0,v0");
2126 #else
2127 asm volatile ("vor 0,0,0");
2128 #endif
2129 return 0;
2130 }
2131 }
3c95e6af
PG
2132
2133 verbose "$me: compiling testfile $src" 2
2134 set lines [gdb_compile $src $exe executable $compile_flags]
2135 file delete $src
2136
2137 if ![string match "" $lines] then {
2138 verbose "$me: testfile compilation failed, returning 1" 2
17e1c970 2139 return 1
3c95e6af
PG
2140 }
2141
2142 # No error message, compilation succeeded so now run it via gdb.
2143
2144 gdb_exit
2145 gdb_start
2146 gdb_reinitialize_dir $srcdir/$subdir
2147 gdb_load "$exe"
2148 gdb_run_cmd
2149 gdb_expect {
2150 -re ".*Illegal instruction.*${gdb_prompt} $" {
2151 verbose -log "\n$me altivec hardware not detected"
17e1c970 2152 set skip_vmx_tests 1
3c95e6af 2153 }
fda326dd 2154 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3c95e6af 2155 verbose -log "\n$me: altivec hardware detected"
17e1c970 2156 set skip_vmx_tests 0
3c95e6af
PG
2157 }
2158 default {
2159 warning "\n$me: default case taken"
17e1c970 2160 set skip_vmx_tests 1
3c95e6af
PG
2161 }
2162 }
2163 gdb_exit
2164 remote_file build delete $exe
2165
17e1c970
TT
2166 verbose "$me: returning $skip_vmx_tests" 2
2167 return $skip_vmx_tests
3c95e6af
PG
2168}
2169
604c2f83
LM
2170# Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2171# 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2172
17e1c970 2173gdb_caching_proc skip_vsx_tests {
fda326dd 2174 global srcdir subdir gdb_prompt inferior_exited_re
604c2f83 2175
604c2f83 2176 set me "skip_vsx_tests"
604c2f83
LM
2177
2178 # Some simulators are known to not support Altivec instructions, so
2179 # they won't support VSX instructions as well.
2180 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2181 verbose "$me: target known to not support VSX, returning 1" 2
17e1c970 2182 return 1
604c2f83
LM
2183 }
2184
2185 # Make sure we have a compiler that understands altivec.
2186 set compile_flags {debug nowarnings quiet}
4c93b1db 2187 if [get_compiler_info] {
604c2f83
LM
2188 warning "Could not get compiler info"
2189 return 1
2190 }
2191 if [test_compiler_info gcc*] {
2192 set compile_flags "$compile_flags additional_flags=-mvsx"
2193 } elseif [test_compiler_info xlc*] {
d9492458 2194 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
604c2f83
LM
2195 } else {
2196 verbose "Could not compile with vsx support, returning 1" 2
2197 return 1
2198 }
2199
4e234898
TT
2200 set src [standard_temp_file vsx[pid].c]
2201 set exe [standard_temp_file vsx[pid].x]
604c2f83 2202
11ec5965
YQ
2203 gdb_produce_source $src {
2204 int main() {
2205 double a[2] = { 1.0, 2.0 };
2206 #ifdef __MACH__
2207 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2208 #else
2209 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2210 #endif
2211 return 0;
2212 }
2213 }
604c2f83
LM
2214
2215 verbose "$me: compiling testfile $src" 2
2216 set lines [gdb_compile $src $exe executable $compile_flags]
2217 file delete $src
2218
2219 if ![string match "" $lines] then {
2220 verbose "$me: testfile compilation failed, returning 1" 2
17e1c970 2221 return 1
604c2f83
LM
2222 }
2223
2224 # No error message, compilation succeeded so now run it via gdb.
2225
2226 gdb_exit
2227 gdb_start
2228 gdb_reinitialize_dir $srcdir/$subdir
2229 gdb_load "$exe"
2230 gdb_run_cmd
2231 gdb_expect {
2232 -re ".*Illegal instruction.*${gdb_prompt} $" {
2233 verbose -log "\n$me VSX hardware not detected"
17e1c970 2234 set skip_vsx_tests 1
604c2f83 2235 }
fda326dd 2236 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
604c2f83 2237 verbose -log "\n$me: VSX hardware detected"
17e1c970 2238 set skip_vsx_tests 0
604c2f83
LM
2239 }
2240 default {
2241 warning "\n$me: default case taken"
17e1c970 2242 set skip_vsx_tests 1
604c2f83
LM
2243 }
2244 }
2245 gdb_exit
2246 remote_file build delete $exe
2247
17e1c970
TT
2248 verbose "$me: returning $skip_vsx_tests" 2
2249 return $skip_vsx_tests
604c2f83
LM
2250}
2251
2f1d9bdd
MM
2252# Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2253# 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2254
f3a76454 2255gdb_caching_proc skip_btrace_tests {
2f1d9bdd
MM
2256 global srcdir subdir gdb_prompt inferior_exited_re
2257
2f1d9bdd 2258 set me "skip_btrace_tests"
2f1d9bdd
MM
2259 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2260 verbose "$me: target does not support btrace, returning 1" 2
f3a76454 2261 return 1
2f1d9bdd
MM
2262 }
2263
2264 # Set up, compile, and execute a test program.
2265 # Include the current process ID in the file names to prevent conflicts
2266 # with invocations for multiple testsuites.
f3a76454
TT
2267 set src [standard_temp_file btrace[pid].c]
2268 set exe [standard_temp_file btrace[pid].x]
2f1d9bdd 2269
11ec5965
YQ
2270 gdb_produce_source $src {
2271 int main(void) { return 0; }
2272 }
2f1d9bdd
MM
2273
2274 verbose "$me: compiling testfile $src" 2
2275 set compile_flags {debug nowarnings quiet}
2276 set lines [gdb_compile $src $exe executable $compile_flags]
2f1d9bdd
MM
2277
2278 if ![string match "" $lines] then {
2279 verbose "$me: testfile compilation failed, returning 1" 2
4043f22b 2280 file delete $src
f3a76454 2281 return 1
2f1d9bdd
MM
2282 }
2283
2284 # No error message, compilation succeeded so now run it via gdb.
2285
f3a76454
TT
2286 gdb_exit
2287 gdb_start
2288 gdb_reinitialize_dir $srcdir/$subdir
2289 gdb_load $exe
2f1d9bdd 2290 if ![runto_main] {
4043f22b 2291 file delete $src
f3a76454 2292 return 1
2f1d9bdd 2293 }
4043f22b 2294 file delete $src
2f1d9bdd 2295 # In case of an unexpected output, we return 2 as a fail value.
f3a76454 2296 set skip_btrace_tests 2
2f1d9bdd
MM
2297 gdb_test_multiple "record btrace" "check btrace support" {
2298 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
f3a76454 2299 set skip_btrace_tests 1
2f1d9bdd
MM
2300 }
2301 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
f3a76454 2302 set skip_btrace_tests 1
2f1d9bdd
MM
2303 }
2304 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
f3a76454 2305 set skip_btrace_tests 1
2f1d9bdd
MM
2306 }
2307 -re "^record btrace\r\n$gdb_prompt $" {
f3a76454 2308 set skip_btrace_tests 0
2f1d9bdd
MM
2309 }
2310 }
2311 gdb_exit
2312 remote_file build delete $exe
2313
f3a76454
TT
2314 verbose "$me: returning $skip_btrace_tests" 2
2315 return $skip_btrace_tests
2f1d9bdd
MM
2316}
2317
7a292a7a
SS
2318# Skip all the tests in the file if you are not on an hppa running
2319# hpux target.
2320
2321proc skip_hp_tests {} {
2322 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
c906108c
SS
2323 verbose "Skip hp tests is $skip_hp"
2324 return $skip_hp
2325}
2326
edb3359d
DJ
2327# Return whether we should skip tests for showing inlined functions in
2328# backtraces. Requires get_compiler_info and get_debug_format.
2329
2330proc skip_inline_frame_tests {} {
2331 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2332 if { ! [test_debug_format "DWARF 2"] } {
2333 return 1
2334 }
2335
2336 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2337 if { ([test_compiler_info "gcc-2-*"]
2338 || [test_compiler_info "gcc-3-*"]
2339 || [test_compiler_info "gcc-4-0-*"]) } {
2340 return 1
2341 }
2342
2343 return 0
2344}
2345
2346# Return whether we should skip tests for showing variables from
2347# inlined functions. Requires get_compiler_info and get_debug_format.
2348
2349proc skip_inline_var_tests {} {
2350 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2351 if { ! [test_debug_format "DWARF 2"] } {
2352 return 1
2353 }
2354
2355 return 0
2356}
2357
b800ec70
UW
2358# Return a 1 if we should skip tests that require hardware breakpoints
2359
2360proc skip_hw_breakpoint_tests {} {
2361 # Skip tests if requested by the board (note that no_hardware_watchpoints
2362 # disables both watchpoints and breakpoints)
2363 if { [target_info exists gdb,no_hardware_watchpoints]} {
2364 return 1
2365 }
2366
2367 # These targets support hardware breakpoints natively
2368 if { [istarget "i?86-*-*"]
2369 || [istarget "x86_64-*-*"]
e3039479
UW
2370 || [istarget "ia64-*-*"]
2371 || [istarget "arm*-*-*"]} {
b800ec70
UW
2372 return 0
2373 }
2374
2375 return 1
2376}
2377
2378# Return a 1 if we should skip tests that require hardware watchpoints
2379
2380proc skip_hw_watchpoint_tests {} {
2381 # Skip tests if requested by the board
2382 if { [target_info exists gdb,no_hardware_watchpoints]} {
2383 return 1
2384 }
2385
2386 # These targets support hardware watchpoints natively
2387 if { [istarget "i?86-*-*"]
2388 || [istarget "x86_64-*-*"]
2389 || [istarget "ia64-*-*"]
e3039479 2390 || [istarget "arm*-*-*"]
b800ec70
UW
2391 || [istarget "powerpc*-*-linux*"]
2392 || [istarget "s390*-*-*"] } {
2393 return 0
2394 }
2395
2396 return 1
2397}
2398
2399# Return a 1 if we should skip tests that require *multiple* hardware
2400# watchpoints to be active at the same time
2401
2402proc skip_hw_watchpoint_multi_tests {} {
2403 if { [skip_hw_watchpoint_tests] } {
2404 return 1
2405 }
2406
2407 # These targets support just a single hardware watchpoint
e3039479
UW
2408 if { [istarget "arm*-*-*"]
2409 || [istarget "powerpc*-*-linux*"] } {
b800ec70
UW
2410 return 1
2411 }
2412
2413 return 0
2414}
2415
2416# Return a 1 if we should skip tests that require read/access watchpoints
2417
2418proc skip_hw_watchpoint_access_tests {} {
2419 if { [skip_hw_watchpoint_tests] } {
2420 return 1
2421 }
2422
2423 # These targets support just write watchpoints
2424 if { [istarget "s390*-*-*"] } {
2425 return 1
2426 }
2427
2428 return 0
2429}
2430
b4893d48
TT
2431# Return 1 if we should skip tests that require the runtime unwinder
2432# hook. This must be invoked while gdb is running, after shared
2433# libraries have been loaded. This is needed because otherwise a
2434# shared libgcc won't be visible.
2435
2436proc skip_unwinder_tests {} {
2437 global gdb_prompt
2438
4442ada7 2439 set ok 0
b4893d48
TT
2440 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2441 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
b4893d48
TT
2442 }
2443 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
4442ada7 2444 set ok 1
b4893d48
TT
2445 }
2446 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
b4893d48
TT
2447 }
2448 }
2449 if {!$ok} {
2450 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2451 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
b4893d48
TT
2452 set ok 1
2453 }
2454 -re "\r\n$gdb_prompt $" {
2455 }
2456 }
2457 }
2458 return $ok
2459}
2460
72f1fe8a
TT
2461# Return 0 if we should skip tests that require the libstdc++ stap
2462# probes. This must be invoked while gdb is running, after shared
2463# libraries have been loaded.
2464
2465proc skip_libstdcxx_probe_tests {} {
2466 global gdb_prompt
2467
2468 set ok 0
2469 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
2470 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
2471 set ok 1
2472 }
2473 -re "\r\n$gdb_prompt $" {
2474 }
2475 }
2476 return $ok
2477}
2478
076855f9
PA
2479# Check whether we're testing with the remote or extended-remote
2480# targets.
2481
2482proc gdb_is_target_remote {} {
2483 global gdb_prompt
2484
2485 set test "probe for target remote"
2486 gdb_test_multiple "maint print target-stack" $test {
2487 -re ".*emote serial target in gdb-specific protocol.*$gdb_prompt $" {
2488 pass $test
2489 return 1
2490 }
2491 -re "$gdb_prompt $" {
2492 pass $test
2493 }
2494 }
2495 return 0
2496}
2497
94b8e876
MC
2498set compiler_info "unknown"
2499set gcc_compiled 0
2500set hp_cc_compiler 0
2501set hp_aCC_compiler 0
94b8e876
MC
2502
2503# Figure out what compiler I am using.
2504#
4c93b1db 2505# ARG can be empty or "C++". If empty, "C" is assumed.
94b8e876
MC
2506#
2507# There are several ways to do this, with various problems.
2508#
2509# [ gdb_compile -E $ifile -o $binfile.ci ]
2510# source $binfile.ci
2511#
2512# Single Unix Spec v3 says that "-E -o ..." together are not
2513# specified. And in fact, the native compiler on hp-ux 11 (among
2514# others) does not work with "-E -o ...". Most targets used to do
2515# this, and it mostly worked, because it works with gcc.
2516#
2517# [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
2518# source $binfile.ci
2519#
2520# This avoids the problem with -E and -o together. This almost works
2521# if the build machine is the same as the host machine, which is
2522# usually true of the targets which are not gcc. But this code does
2523# not figure which compiler to call, and it always ends up using the C
2524# compiler. Not good for setting hp_aCC_compiler. Targets
2525# hppa*-*-hpux* and mips*-*-irix* used to do this.
2526#
2527# [ gdb_compile -E $ifile > $binfile.ci ]
2528# source $binfile.ci
2529#
2530# dejagnu target_compile says that it supports output redirection,
2531# but the code is completely different from the normal path and I
2532# don't want to sweep the mines from that path. So I didn't even try
2533# this.
2534#
2535# set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
2536# eval $cppout
2537#
2538# I actually do this for all targets now. gdb_compile runs the right
2539# compiler, and TCL captures the output, and I eval the output.
2540#
2541# Unfortunately, expect logs the output of the command as it goes by,
2542# and dejagnu helpfully prints a second copy of it right afterwards.
2543# So I turn off expect logging for a moment.
2544#
2545# [ gdb_compile $ifile $ciexe_file executable $args ]
2546# [ remote_exec $ciexe_file ]
2547# [ source $ci_file.out ]
2548#
2549# I could give up on -E and just do this.
2550# I didn't get desperate enough to try this.
2551#
2552# -- chastain 2004-01-06
853d6e5b 2553
4c93b1db 2554proc get_compiler_info {{arg ""}} {
94b8e876 2555 # For compiler.c and compiler.cc
c906108c 2556 global srcdir
94b8e876
MC
2557
2558 # I am going to play with the log to keep noise out.
2559 global outdir
2560 global tool
2561
2562 # These come from compiler.c or compiler.cc
853d6e5b 2563 global compiler_info
4f70a4c9
MC
2564
2565 # Legacy global data symbols.
94b8e876
MC
2566 global gcc_compiled
2567 global hp_cc_compiler
2568 global hp_aCC_compiler
c906108c 2569
94b8e876
MC
2570 # Choose which file to preprocess.
2571 set ifile "${srcdir}/lib/compiler.c"
4c93b1db 2572 if { $arg == "c++" } {
94b8e876 2573 set ifile "${srcdir}/lib/compiler.cc"
c906108c 2574 }
085dd6e6 2575
94b8e876
MC
2576 # Run $ifile through the right preprocessor.
2577 # Toggle gdb.log to keep the compiler output out of the log.
95d7853e 2578 set saved_log [log_file -info]
94b8e876 2579 log_file
e7f86de9
JM
2580 if [is_remote host] {
2581 # We have to use -E and -o together, despite the comments
2582 # above, because of how DejaGnu handles remote host testing.
2583 set ppout "$outdir/compiler.i"
4c93b1db 2584 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
e7f86de9
JM
2585 set file [open $ppout r]
2586 set cppout [read $file]
2587 close $file
2588 } else {
4c93b1db 2589 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
e7f86de9 2590 }
95d7853e 2591 eval log_file $saved_log
94b8e876 2592
4f70a4c9
MC
2593 # Eval the output.
2594 set unknown 0
94b8e876 2595 foreach cppline [ split "$cppout" "\n" ] {
4f70a4c9
MC
2596 if { [ regexp "^#" "$cppline" ] } {
2597 # line marker
2598 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
2599 # blank line
2600 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
2601 # eval this line
2602 verbose "get_compiler_info: $cppline" 2
2603 eval "$cppline"
2604 } else {
2605 # unknown line
2606 verbose -log "get_compiler_info: $cppline"
2607 set unknown 1
94b8e876 2608 }
085dd6e6 2609 }
4f70a4c9
MC
2610
2611 # Reset to unknown compiler if any diagnostics happened.
2612 if { $unknown } {
2613 set compiler_info "unknown"
4f70a4c9
MC
2614 }
2615
2616 # Set the legacy symbols.
2617 set gcc_compiled 0
2618 set hp_cc_compiler 0
2619 set hp_aCC_compiler 0
2620 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
2621 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
2622 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
2623 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
2624 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
2625 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
2626 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
2627
2628 # Log what happened.
94b8e876 2629 verbose -log "get_compiler_info: $compiler_info"
085dd6e6
JM
2630
2631 # Most compilers will evaluate comparisons and other boolean
2632 # operations to 0 or 1.
2633 uplevel \#0 { set true 1 }
2634 uplevel \#0 { set false 0 }
2635
94b8e876
MC
2636 # Use of aCC results in boolean results being displayed as
2637 # "true" or "false"
2638 if { $hp_aCC_compiler } {
2639 uplevel \#0 { set true true }
2640 uplevel \#0 { set false false }
085dd6e6
JM
2641 }
2642
ae59b1da 2643 return 0
c906108c
SS
2644}
2645
9b593790 2646proc test_compiler_info { {compiler ""} } {
853d6e5b 2647 global compiler_info
6e87504d
PG
2648
2649 # if no arg, return the compiler_info string
2650
2651 if [string match "" $compiler] {
2652 if [info exists compiler_info] {
2653 return $compiler_info
2654 } else {
2655 perror "No compiler info found."
2656 }
2657 }
2658
853d6e5b
AC
2659 return [string match $compiler $compiler_info]
2660}
2661
f6838f81
DJ
2662proc current_target_name { } {
2663 global target_info
2664 if [info exists target_info(target,name)] {
2665 set answer $target_info(target,name)
2666 } else {
2667 set answer ""
2668 }
2669 return $answer
2670}
2671
f1c47eb2 2672set gdb_wrapper_initialized 0
f6838f81 2673set gdb_wrapper_target ""
f1c47eb2
MS
2674
2675proc gdb_wrapper_init { args } {
4ec70201
PA
2676 global gdb_wrapper_initialized
2677 global gdb_wrapper_file
2678 global gdb_wrapper_flags
f6838f81 2679 global gdb_wrapper_target
f1c47eb2
MS
2680
2681 if { $gdb_wrapper_initialized == 1 } { return; }
2682
2683 if {[target_info exists needs_status_wrapper] && \
277254ba 2684 [target_info needs_status_wrapper] != "0"} {
4ec70201 2685 set result [build_wrapper "testglue.o"]
f1c47eb2 2686 if { $result != "" } {
4ec70201
PA
2687 set gdb_wrapper_file [lindex $result 0]
2688 set gdb_wrapper_flags [lindex $result 1]
f1c47eb2
MS
2689 } else {
2690 warning "Status wrapper failed to build."
2691 }
2692 }
2693 set gdb_wrapper_initialized 1
f6838f81 2694 set gdb_wrapper_target [current_target_name]
f1c47eb2
MS
2695}
2696
f747e0ce
PA
2697# Some targets need to always link a special object in. Save its path here.
2698global gdb_saved_set_unbuffered_mode_obj
2699set gdb_saved_set_unbuffered_mode_obj ""
2700
c906108c 2701proc gdb_compile {source dest type options} {
4ec70201
PA
2702 global GDB_TESTCASE_OPTIONS
2703 global gdb_wrapper_file
2704 global gdb_wrapper_flags
2705 global gdb_wrapper_initialized
f747e0ce
PA
2706 global srcdir
2707 global objdir
2708 global gdb_saved_set_unbuffered_mode_obj
c906108c 2709
695e2681
MK
2710 set outdir [file dirname $dest]
2711
2712 # Add platform-specific options if a shared library was specified using
2713 # "shlib=librarypath" in OPTIONS.
2714 set new_options ""
2715 set shlib_found 0
bdf7534a 2716 set shlib_load 0
695e2681 2717 foreach opt $options {
57bf0e56
DJ
2718 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
2719 if [test_compiler_info "xlc-*"] {
93f02886
DJ
2720 # IBM xlc compiler doesn't accept shared library named other
2721 # than .so: use "-Wl," to bypass this
2722 lappend source "-Wl,$shlib_name"
2723 } elseif { ([istarget "*-*-mingw*"]
2724 || [istarget *-*-cygwin*]
2725 || [istarget *-*-pe*])} {
2726 lappend source "${shlib_name}.a"
57bf0e56
DJ
2727 } else {
2728 lappend source $shlib_name
2729 }
0413d738 2730 if { $shlib_found == 0 } {
57bf0e56 2731 set shlib_found 1
0413d738
PA
2732 if { ([istarget "*-*-mingw*"]
2733 || [istarget *-*-cygwin*]) } {
bb61102d 2734 lappend new_options "additional_flags=-Wl,--enable-auto-import"
0413d738 2735 }
57bf0e56 2736 }
b0f4b84b 2737 } elseif { $opt == "shlib_load" } {
bdf7534a 2738 set shlib_load 1
57bf0e56
DJ
2739 } else {
2740 lappend new_options $opt
2741 }
695e2681 2742 }
bdf7534a
NF
2743
2744 # We typically link to shared libraries using an absolute path, and
2745 # that's how they are found at runtime. If we are going to
2746 # dynamically load one by basename, we must specify rpath. If we
2747 # are using a remote host, DejaGNU will link to the shared library
2748 # using a relative path, so again we must specify an rpath.
31f83dc5 2749 if { $shlib_load || ($shlib_found && [is_remote target]) } {
bdf7534a
NF
2750 if { ([istarget "*-*-mingw*"]
2751 || [istarget *-*-cygwin*]
2752 || [istarget *-*-pe*]
bdf7534a
NF
2753 || [istarget hppa*-*-hpux*])} {
2754 # Do not need anything.
b2a6bdeb 2755 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
d8b34041 2756 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
759f0f0b
PA
2757 } elseif { [istarget arm*-*-symbianelf*] } {
2758 if { $shlib_load } {
2759 lappend new_options "libs=-ldl"
2760 }
bdf7534a
NF
2761 } else {
2762 if { $shlib_load } {
2763 lappend new_options "libs=-ldl"
2764 }
d8b34041 2765 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
bdf7534a
NF
2766 }
2767 }
695e2681 2768 set options $new_options
57bf0e56 2769
c906108c
SS
2770 if [target_info exists is_vxworks] {
2771 set options2 { "additional_flags=-Dvxworks" }
c906108c
SS
2772 set options [concat $options2 $options]
2773 }
2774 if [info exists GDB_TESTCASE_OPTIONS] {
4ec70201 2775 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
c906108c
SS
2776 }
2777 verbose "options are $options"
2778 verbose "source is $source $dest $type $options"
2779
f1c47eb2
MS
2780 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
2781
2782 if {[target_info exists needs_status_wrapper] && \
2783 [target_info needs_status_wrapper] != "0" && \
2784 [info exists gdb_wrapper_file]} {
2785 lappend options "libs=${gdb_wrapper_file}"
2786 lappend options "ldflags=${gdb_wrapper_flags}"
2787 }
2788
fc91c6c2
PB
2789 # Replace the "nowarnings" option with the appropriate additional_flags
2790 # to disable compiler warnings.
2791 set nowarnings [lsearch -exact $options nowarnings]
2792 if {$nowarnings != -1} {
2793 if [target_info exists gdb,nowarnings_flag] {
2794 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
2795 } else {
2796 set flag "additional_flags=-w"
2797 }
2798 set options [lreplace $options $nowarnings $nowarnings $flag]
2799 }
2800
f747e0ce
PA
2801 if { $type == "executable" } {
2802 if { ([istarget "*-*-mingw*"]
56643c5e 2803 || [istarget "*-*-*djgpp"]
f747e0ce
PA
2804 || [istarget "*-*-cygwin*"])} {
2805 # Force output to unbuffered mode, by linking in an object file
2806 # with a global contructor that calls setvbuf.
2807 #
2808 # Compile the special object seperatelly for two reasons:
2809 # 1) Insulate it from $options.
2810 # 2) Avoid compiling it for every gdb_compile invocation,
2811 # which is time consuming, especially if we're remote
2812 # host testing.
2813 #
2814 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
2815 verbose "compiling gdb_saved_set_unbuffered_obj"
2816 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
2817 set unbuf_obj ${objdir}/set_unbuffered_mode.o
2818
2819 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
2820 if { $result != "" } {
2821 return $result
2822 }
f6dc277e
YQ
2823 if {[is_remote host]} {
2824 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
2825 } else {
2826 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
2827 }
f747e0ce
PA
2828 # Link a copy of the output object, because the
2829 # original may be automatically deleted.
f6dc277e 2830 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
f747e0ce
PA
2831 } else {
2832 verbose "gdb_saved_set_unbuffered_obj already compiled"
2833 }
2834
2835 # Rely on the internal knowledge that the global ctors are ran in
2836 # reverse link order. In that case, we can use ldflags to
2837 # avoid copying the object file to the host multiple
2838 # times.
ace5c364
PM
2839 # This object can only be added if standard libraries are
2840 # used. Thus, we need to disable it if -nostdlib option is used
2841 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
2842 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
2843 }
f747e0ce
PA
2844 }
2845 }
2846
4ec70201 2847 set result [target_compile $source $dest $type $options]
93f02886
DJ
2848
2849 # Prune uninteresting compiler (and linker) output.
2850 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
2851
4ec70201
PA
2852 regsub "\[\r\n\]*$" "$result" "" result
2853 regsub "^\[\r\n\]*" "$result" "" result
ec3c07fc
NS
2854
2855 if {[lsearch $options quiet] < 0} {
2856 # We shall update this on a per language basis, to avoid
2857 # changing the entire testsuite in one go.
2858 if {[lsearch $options f77] >= 0} {
2859 gdb_compile_test $source $result
2860 } elseif { $result != "" } {
2861 clone_output "gdb compile failed, $result"
2862 }
c906108c 2863 }
ae59b1da 2864 return $result
c906108c
SS
2865}
2866
b6ff0e81
JB
2867
2868# This is just like gdb_compile, above, except that it tries compiling
2869# against several different thread libraries, to see which one this
2870# system has.
2871proc gdb_compile_pthreads {source dest type options} {
0ae67eb3 2872 set built_binfile 0
b6ff0e81 2873 set why_msg "unrecognized error"
24486cb7 2874 foreach lib {-lpthreads -lpthread -lthread ""} {
b6ff0e81
JB
2875 # This kind of wipes out whatever libs the caller may have
2876 # set. Or maybe theirs will override ours. How infelicitous.
b5ab8ff3 2877 set options_with_lib [concat $options [list libs=$lib quiet]]
b6ff0e81
JB
2878 set ccout [gdb_compile $source $dest $type $options_with_lib]
2879 switch -regexp -- $ccout {
2880 ".*no posix threads support.*" {
2881 set why_msg "missing threads include file"
2882 break
2883 }
2884 ".*cannot open -lpthread.*" {
2885 set why_msg "missing runtime threads library"
2886 }
2887 ".*Can't find library for -lpthread.*" {
2888 set why_msg "missing runtime threads library"
2889 }
2890 {^$} {
2891 pass "successfully compiled posix threads test case"
2892 set built_binfile 1
2893 break
2894 }
2895 }
2896 }
0ae67eb3 2897 if {!$built_binfile} {
40d1a503 2898 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
b6ff0e81
JB
2899 return -1
2900 }
57bf0e56
DJ
2901}
2902
409d8f48 2903# Build a shared library from SOURCES.
57bf0e56
DJ
2904
2905proc gdb_compile_shlib {sources dest options} {
2906 set obj_options $options
2907
409d8f48
AB
2908 set info_options ""
2909 if { [lsearch -exact $options "c++"] >= 0 } {
2910 set info_options "c++"
2911 }
2912 if [get_compiler_info ${info_options}] {
2913 return -1
2914 }
2915
57bf0e56
DJ
2916 switch -glob [test_compiler_info] {
2917 "xlc-*" {
2918 lappend obj_options "additional_flags=-qpic"
2919 }
2920 "gcc-*" {
2921 if { !([istarget "powerpc*-*-aix*"]
227c54da
DJ
2922 || [istarget "rs6000*-*-aix*"]
2923 || [istarget "*-*-cygwin*"]
2924 || [istarget "*-*-mingw*"]
2925 || [istarget "*-*-pe*"]) } {
57bf0e56
DJ
2926 lappend obj_options "additional_flags=-fpic"
2927 }
2928 }
2929 default {
2930 switch -glob [istarget] {
2931 "hppa*-hp-hpux*" {
2932 lappend obj_options "additional_flags=+z"
2933 }
2934 "mips-sgi-irix*" {
2935 # Disable SGI compiler's implicit -Dsgi
2936 lappend obj_options "additional_flags=-Usgi"
2937 }
2938 default {
2939 # don't know what the compiler is...
2940 }
2941 }
2942 }
2943 }
2944
2945 set outdir [file dirname $dest]
2946 set objects ""
2947 foreach source $sources {
2948 set sourcebase [file tail $source]
2949 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
2950 return -1
2951 }
2952 lappend objects ${outdir}/${sourcebase}.o
2953 }
2954
2955 if [istarget "hppa*-*-hpux*"] {
2956 remote_exec build "ld -b ${objects} -o ${dest}"
2957 } else {
2958 set link_options $options
2959 if [test_compiler_info "xlc-*"] {
2960 lappend link_options "additional_flags=-qmkshrobj"
2961 } else {
2962 lappend link_options "additional_flags=-shared"
93f02886
DJ
2963
2964 if { ([istarget "*-*-mingw*"]
2965 || [istarget *-*-cygwin*]
a075c3e5
YQ
2966 || [istarget *-*-pe*]) } {
2967 if { [is_remote host] } {
2968 set name [file tail ${dest}]
2969 } else {
2970 set name ${dest}
2971 }
2972 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
31f83dc5
UW
2973 } elseif [is_remote target] {
2974 # By default, we do not set the soname. This causes the linker
2975 # on ELF systems to create a DT_NEEDED entry in the executable
2976 # refering to the full path name of the library. This is a
2977 # problem in remote testing if the library is in a different
2978 # directory there. To fix this, we set a soname of just the
2979 # base filename for the library, and add an appropriate -rpath
2980 # to the main executable (in gdb_compile).
2981 set destbase [file tail $dest]
2982 lappend link_options "additional_flags=-Wl,-soname,$destbase"
2983 }
57bf0e56
DJ
2984 }
2985 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
2986 return -1
2987 }
a075c3e5
YQ
2988 if { [is_remote host]
2989 && ([istarget "*-*-mingw*"]
2990 || [istarget *-*-cygwin*]
2991 || [istarget *-*-pe*]) } {
2992 set dest_tail_name [file tail ${dest}]
2993 remote_upload host $dest_tail_name.a ${dest}.a
2994 remote_file host delete $dest_tail_name.a
2995 }
57bf0e56 2996 }
a075c3e5 2997 return ""
b6ff0e81
JB
2998}
2999
756d88a7
UW
3000# This is just like gdb_compile_shlib, above, except that it tries compiling
3001# against several different thread libraries, to see which one this
3002# system has.
3003proc gdb_compile_shlib_pthreads {sources dest options} {
3004 set built_binfile 0
3005 set why_msg "unrecognized error"
3006 foreach lib {-lpthreads -lpthread -lthread ""} {
3007 # This kind of wipes out whatever libs the caller may have
3008 # set. Or maybe theirs will override ours. How infelicitous.
3009 set options_with_lib [concat $options [list libs=$lib quiet]]
3010 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
3011 switch -regexp -- $ccout {
3012 ".*no posix threads support.*" {
3013 set why_msg "missing threads include file"
3014 break
3015 }
3016 ".*cannot open -lpthread.*" {
3017 set why_msg "missing runtime threads library"
3018 }
3019 ".*Can't find library for -lpthread.*" {
3020 set why_msg "missing runtime threads library"
3021 }
3022 {^$} {
3023 pass "successfully compiled posix threads test case"
3024 set built_binfile 1
3025 break
3026 }
3027 }
3028 }
3029 if {!$built_binfile} {
3030 unsupported "Couldn't compile $sources: ${why_msg}"
3031 return -1
3032 }
3033}
3034
130cacce
AF
3035# This is just like gdb_compile_pthreads, above, except that we always add the
3036# objc library for compiling Objective-C programs
3037proc gdb_compile_objc {source dest type options} {
3038 set built_binfile 0
3039 set why_msg "unrecognized error"
3040 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
3041 # This kind of wipes out whatever libs the caller may have
3042 # set. Or maybe theirs will override ours. How infelicitous.
3043 if { $lib == "solaris" } {
3044 set lib "-lpthread -lposix4"
3045 }
3046 if { $lib != "-lobjc" } {
3047 set lib "-lobjc $lib"
3048 }
3049 set options_with_lib [concat $options [list libs=$lib quiet]]
3050 set ccout [gdb_compile $source $dest $type $options_with_lib]
3051 switch -regexp -- $ccout {
3052 ".*no posix threads support.*" {
3053 set why_msg "missing threads include file"
3054 break
3055 }
3056 ".*cannot open -lpthread.*" {
3057 set why_msg "missing runtime threads library"
3058 }
3059 ".*Can't find library for -lpthread.*" {
3060 set why_msg "missing runtime threads library"
3061 }
3062 {^$} {
3063 pass "successfully compiled objc with posix threads test case"
3064 set built_binfile 1
3065 break
3066 }
3067 }
3068 }
3069 if {!$built_binfile} {
40d1a503 3070 unsupported "Couldn't compile [file tail $source]: ${why_msg}"
130cacce
AF
3071 return -1
3072 }
3073}
3074
c906108c 3075proc send_gdb { string } {
4ec70201 3076 global suppress_flag
c906108c 3077 if { $suppress_flag } {
ae59b1da 3078 return "suppressed"
c906108c 3079 }
ae59b1da 3080 return [remote_send host "$string"]
c906108c
SS
3081}
3082
3083#
3084#
3085
3086proc gdb_expect { args } {
3087 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
4ec70201
PA
3088 set atimeout [lindex $args 0]
3089 set expcode [list [lindex $args 1]]
c906108c 3090 } else {
4ec70201 3091 set expcode $args
2f34202f
MR
3092 }
3093
4ec70201 3094 upvar timeout timeout
2f34202f
MR
3095
3096 if [target_info exists gdb,timeout] {
3097 if [info exists timeout] {
3098 if { $timeout < [target_info gdb,timeout] } {
4ec70201 3099 set gtimeout [target_info gdb,timeout]
2f34202f 3100 } else {
4ec70201 3101 set gtimeout $timeout
c906108c 3102 }
2f34202f 3103 } else {
4ec70201 3104 set gtimeout [target_info gdb,timeout]
c906108c 3105 }
2f34202f 3106 }
c906108c 3107
2f34202f 3108 if ![info exists gtimeout] {
4ec70201 3109 global timeout
2f34202f 3110 if [info exists timeout] {
4ec70201 3111 set gtimeout $timeout
2f34202f
MR
3112 }
3113 }
3114
3115 if [info exists atimeout] {
3116 if { ![info exists gtimeout] || $gtimeout < $atimeout } {
4ec70201 3117 set gtimeout $atimeout
2f34202f
MR
3118 }
3119 } else {
c906108c 3120 if ![info exists gtimeout] {
2f34202f 3121 # Eeeeew.
4ec70201 3122 set gtimeout 60
c906108c
SS
3123 }
3124 }
2f34202f 3125
4ec70201
PA
3126 global suppress_flag
3127 global remote_suppress_flag
c906108c 3128 if [info exists remote_suppress_flag] {
4ec70201 3129 set old_val $remote_suppress_flag
c906108c
SS
3130 }
3131 if [info exists suppress_flag] {
3132 if { $suppress_flag } {
4ec70201 3133 set remote_suppress_flag 1
c906108c
SS
3134 }
3135 }
a0b3c4fd 3136 set code [catch \
4ec70201 3137 {uplevel remote_expect host $gtimeout $expcode} string]
c906108c 3138 if [info exists old_val] {
4ec70201 3139 set remote_suppress_flag $old_val
c906108c
SS
3140 } else {
3141 if [info exists remote_suppress_flag] {
4ec70201 3142 unset remote_suppress_flag
c906108c
SS
3143 }
3144 }
3145
3146 if {$code == 1} {
4ec70201 3147 global errorInfo errorCode
c906108c
SS
3148
3149 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
d6d7a51a 3150 } else {
c906108c
SS
3151 return -code $code $string
3152 }
3153}
3154
5fa290c1 3155# gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
085dd6e6
JM
3156#
3157# Check for long sequence of output by parts.
5fa290c1 3158# TEST: is the test message to be printed with the test success/fail.
085dd6e6
JM
3159# SENTINEL: Is the terminal pattern indicating that output has finished.
3160# LIST: is the sequence of outputs to match.
3161# If the sentinel is recognized early, it is considered an error.
3162#
11cf8741
JM
3163# Returns:
3164# 1 if the test failed,
3165# 0 if the test passes,
3166# -1 if there was an internal error.
5fa290c1 3167
c2d11a7d 3168proc gdb_expect_list {test sentinel list} {
085dd6e6 3169 global gdb_prompt
11cf8741 3170 global suppress_flag
085dd6e6 3171 set index 0
43ff13b4 3172 set ok 1
11cf8741
JM
3173 if { $suppress_flag } {
3174 set ok 0
a20ce2c3 3175 unresolved "${test}"
11cf8741 3176 }
43ff13b4 3177 while { ${index} < [llength ${list}] } {
085dd6e6
JM
3178 set pattern [lindex ${list} ${index}]
3179 set index [expr ${index} + 1]
6b0ecdc2 3180 verbose -log "gdb_expect_list pattern: /$pattern/" 2
085dd6e6 3181 if { ${index} == [llength ${list}] } {
43ff13b4
JM
3182 if { ${ok} } {
3183 gdb_expect {
c2d11a7d 3184 -re "${pattern}${sentinel}" {
a20ce2c3 3185 # pass "${test}, pattern ${index} + sentinel"
c2d11a7d
JM
3186 }
3187 -re "${sentinel}" {
a20ce2c3 3188 fail "${test} (pattern ${index} + sentinel)"
c2d11a7d 3189 set ok 0
43ff13b4 3190 }
5c5455dc
AC
3191 -re ".*A problem internal to GDB has been detected" {
3192 fail "${test} (GDB internal error)"
3193 set ok 0
3194 gdb_internal_error_resync
3195 }
43ff13b4 3196 timeout {
a20ce2c3 3197 fail "${test} (pattern ${index} + sentinel) (timeout)"
43ff13b4
JM
3198 set ok 0
3199 }
085dd6e6 3200 }
43ff13b4 3201 } else {
a20ce2c3 3202 # unresolved "${test}, pattern ${index} + sentinel"
085dd6e6
JM
3203 }
3204 } else {
43ff13b4
JM
3205 if { ${ok} } {
3206 gdb_expect {
3207 -re "${pattern}" {
a20ce2c3 3208 # pass "${test}, pattern ${index}"
43ff13b4 3209 }
c2d11a7d 3210 -re "${sentinel}" {
a20ce2c3 3211 fail "${test} (pattern ${index})"
43ff13b4
JM
3212 set ok 0
3213 }
5c5455dc
AC
3214 -re ".*A problem internal to GDB has been detected" {
3215 fail "${test} (GDB internal error)"
3216 set ok 0
3217 gdb_internal_error_resync
3218 }
43ff13b4 3219 timeout {
a20ce2c3 3220 fail "${test} (pattern ${index}) (timeout)"
43ff13b4
JM
3221 set ok 0
3222 }
085dd6e6 3223 }
43ff13b4 3224 } else {
a20ce2c3 3225 # unresolved "${test}, pattern ${index}"
085dd6e6
JM
3226 }
3227 }
3228 }
11cf8741 3229 if { ${ok} } {
a20ce2c3 3230 pass "${test}"
11cf8741
JM
3231 return 0
3232 } else {
3233 return 1
3234 }
085dd6e6
JM
3235}
3236
3237#
3238#
c906108c 3239proc gdb_suppress_entire_file { reason } {
4ec70201 3240 global suppress_flag
c906108c 3241
4ec70201
PA
3242 warning "$reason\n"
3243 set suppress_flag -1
c906108c
SS
3244}
3245
3246#
3247# Set suppress_flag, which will cause all subsequent calls to send_gdb and
3248# gdb_expect to fail immediately (until the next call to
3249# gdb_stop_suppressing_tests).
3250#
3251proc gdb_suppress_tests { args } {
4ec70201 3252 global suppress_flag
c906108c
SS
3253
3254 return; # fnf - disable pending review of results where
3255 # testsuite ran better without this
4ec70201 3256 incr suppress_flag
c906108c
SS
3257
3258 if { $suppress_flag == 1 } {
3259 if { [llength $args] > 0 } {
4ec70201 3260 warning "[lindex $args 0]\n"
c906108c 3261 } else {
4ec70201 3262 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
c906108c
SS
3263 }
3264 }
3265}
3266
3267#
3268# Clear suppress_flag.
3269#
3270proc gdb_stop_suppressing_tests { } {
4ec70201 3271 global suppress_flag
c906108c
SS
3272
3273 if [info exists suppress_flag] {
3274 if { $suppress_flag > 0 } {
4ec70201
PA
3275 set suppress_flag 0
3276 clone_output "Tests restarted.\n"
c906108c
SS
3277 }
3278 } else {
4ec70201 3279 set suppress_flag 0
c906108c
SS
3280 }
3281}
3282
3283proc gdb_clear_suppressed { } {
4ec70201 3284 global suppress_flag
c906108c 3285
4ec70201 3286 set suppress_flag 0
c906108c
SS
3287}
3288
3289proc gdb_start { } {
3290 default_gdb_start
3291}
3292
3293proc gdb_exit { } {
3294 catch default_gdb_exit
3295}
3296
e63b55d1
NS
3297#
3298# gdb_load_cmd -- load a file into the debugger.
3299# ARGS - additional args to load command.
3300# return a -1 if anything goes wrong.
3301#
3302proc gdb_load_cmd { args } {
3303 global gdb_prompt
3304
3305 if [target_info exists gdb_load_timeout] {
3306 set loadtimeout [target_info gdb_load_timeout]
3307 } else {
3308 set loadtimeout 1600
3309 }
3310 send_gdb "load $args\n"
e91528f0 3311 verbose "Timeout is now $loadtimeout seconds" 2
e63b55d1
NS
3312 gdb_expect $loadtimeout {
3313 -re "Loading section\[^\r\]*\r\n" {
3314 exp_continue
3315 }
3316 -re "Start address\[\r\]*\r\n" {
3317 exp_continue
3318 }
3319 -re "Transfer rate\[\r\]*\r\n" {
3320 exp_continue
3321 }
3322 -re "Memory access error\[^\r\]*\r\n" {
3323 perror "Failed to load program"
3324 return -1
3325 }
3326 -re "$gdb_prompt $" {
3327 return 0
3328 }
3329 -re "(.*)\r\n$gdb_prompt " {
3330 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
3331 return -1
3332 }
3333 timeout {
c4b347c7 3334 perror "Timed out trying to load $args."
e63b55d1
NS
3335 return -1
3336 }
3337 }
3338 return -1
3339}
3340
2d338fa9
TT
3341# Invoke "gcore". CORE is the name of the core file to write. TEST
3342# is the name of the test case. This will return 1 if the core file
3343# was created, 0 otherwise. If this fails to make a core file because
3344# this configuration of gdb does not support making core files, it
3345# will call "unsupported", not "fail". However, if this fails to make
3346# a core file for some other reason, then it will call "fail".
3347
3348proc gdb_gcore_cmd {core test} {
3349 global gdb_prompt
3350
3351 set result 0
3352 gdb_test_multiple "gcore $core" $test {
3353 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
3354 pass $test
3355 set result 1
3356 }
3357
3358 -re "Undefined command.*$gdb_prompt $" {
3359 unsupported $test
3360 verbose -log "'gcore' command undefined in gdb_gcore_cmd"
3361 }
3362
bbe769cc 3363 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
2d338fa9
TT
3364 unsupported $test
3365 }
3366 }
3367
3368 return $result
3369}
3370
fac51dd9
DE
3371# Load core file CORE. TEST is the name of the test case.
3372# This will record a pass/fail for loading the core file.
3373# Returns:
3374# 1 - core file is successfully loaded
3375# 0 - core file loaded but has a non fatal error
3376# -1 - core file failed to load
3377
3378proc gdb_core_cmd { core test } {
3379 global gdb_prompt
3380
4f424bb1 3381 gdb_test_multiple "core $core" "$test" {
fac51dd9
DE
3382 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
3383 exp_continue
3384 }
3385 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4f424bb1 3386 fail "$test (bad file format)"
fac51dd9
DE
3387 return -1
3388 }
3389 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4f424bb1 3390 fail "$test (file not found)"
fac51dd9
DE
3391 return -1
3392 }
3393 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4f424bb1 3394 fail "$test (incomplete note section)"
fac51dd9
DE
3395 return 0
3396 }
3397 -re "Core was generated by .*\r\n$gdb_prompt $" {
4f424bb1 3398 pass "$test"
fac51dd9
DE
3399 return 1
3400 }
3401 -re ".*$gdb_prompt $" {
4f424bb1 3402 fail "$test"
fac51dd9
DE
3403 return -1
3404 }
3405 timeout {
4f424bb1 3406 fail "$test (timeout)"
fac51dd9
DE
3407 return -1
3408 }
3409 }
3410 fail "unsupported output from 'core' command"
3411 return -1
3412}
3413
759f0f0b
PA
3414# Return the filename to download to the target and load on the target
3415# for this shared library. Normally just LIBNAME, unless shared libraries
3416# for this target have separate link and load images.
3417
3418proc shlib_target_file { libname } {
3419 return $libname
3420}
3421
3422# Return the filename GDB will load symbols from when debugging this
3423# shared library. Normally just LIBNAME, unless shared libraries for
3424# this target have separate link and load images.
3425
3426proc shlib_symbol_file { libname } {
3427 return $libname
3428}
3429
56744f0a
JJ
3430# Return the filename to download to the target and load for this
3431# executable. Normally just BINFILE unless it is renamed to something
3432# else for this target.
3433
3434proc exec_target_file { binfile } {
3435 return $binfile
3436}
3437
3438# Return the filename GDB will load symbols from when debugging this
3439# executable. Normally just BINFILE unless executables for this target
3440# have separate files for symbols.
3441
3442proc exec_symbol_file { binfile } {
3443 return $binfile
3444}
3445
3446# Rename the executable file. Normally this is just BINFILE1 being renamed
3447# to BINFILE2, but some targets require multiple binary files.
3448proc gdb_rename_execfile { binfile1 binfile2 } {
faf067f1
JK
3449 file rename -force [exec_target_file ${binfile1}] \
3450 [exec_target_file ${binfile2}]
56744f0a 3451 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
faf067f1
JK
3452 file rename -force [exec_symbol_file ${binfile1}] \
3453 [exec_symbol_file ${binfile2}]
56744f0a
JJ
3454 }
3455}
3456
3457# "Touch" the executable file to update the date. Normally this is just
3458# BINFILE, but some targets require multiple files.
3459proc gdb_touch_execfile { binfile } {
faf067f1
JK
3460 set time [clock seconds]
3461 file mtime [exec_target_file ${binfile}] $time
56744f0a 3462 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
faf067f1 3463 file mtime [exec_symbol_file ${binfile}] $time
56744f0a
JJ
3464 }
3465}
3466
44ee8174
TT
3467# Like remote_download but provides a gdb-specific behavior. If DEST
3468# is "host", and the host is not remote, and TOFILE is not specified,
3469# then the [file tail] of FROMFILE is passed through
3470# standard_output_file to compute the destination.
3471
3472proc gdb_remote_download {dest fromfile {tofile {}}} {
3473 if {$dest == "host" && ![is_remote host] && $tofile == ""} {
3474 set tofile [standard_output_file [file tail $fromfile]]
3475 }
ce4ea2bb
YQ
3476
3477 if { $tofile == "" } {
3478 return [remote_download $dest $fromfile]
3479 } else {
3480 return [remote_download $dest $fromfile $tofile]
3481 }
44ee8174
TT
3482}
3483
93f02886
DJ
3484# gdb_download
3485#
3486# Copy a file to the remote target and return its target filename.
3487# Schedule the file to be deleted at the end of this test.
3488
3489proc gdb_download { filename } {
3490 global cleanfiles
3491
3492 set destname [remote_download target $filename]
3493 lappend cleanfiles $destname
3494 return $destname
3495}
3496
3497# gdb_load_shlibs LIB...
3498#
3499# Copy the listed libraries to the target.
3500
3501proc gdb_load_shlibs { args } {
3502 if {![is_remote target]} {
3503 return
3504 }
3505
3506 foreach file $args {
759f0f0b 3507 gdb_download [shlib_target_file $file]
93f02886
DJ
3508 }
3509
3510 # Even if the target supplies full paths for shared libraries,
3511 # they may not be paths for this system.
3512 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
3513}
3514
c906108c 3515#
5b80f00d
PA
3516# gdb_load -- load a file into the debugger. Specifying no file
3517# defaults to the executable currently being debugged.
2db8e78e 3518# Many files in config/*.exp override this procedure.
c906108c
SS
3519#
3520proc gdb_load { arg } {
5b80f00d
PA
3521 if { $arg != "" } {
3522 return [gdb_file_cmd $arg]
3523 }
c906108c
SS
3524}
3525
b741e217
DJ
3526# gdb_reload -- load a file into the target. Called before "running",
3527# either the first time or after already starting the program once,
3528# for remote targets. Most files that override gdb_load should now
3529# override this instead.
3530
3531proc gdb_reload { } {
3532 # For the benefit of existing configurations, default to gdb_load.
3533 # Specifying no file defaults to the executable currently being
3534 # debugged.
3535 return [gdb_load ""]
3536}
3537
c906108c
SS
3538proc gdb_continue { function } {
3539 global decimal
3540
ae59b1da 3541 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
c906108c
SS
3542}
3543
73c9764f 3544proc default_gdb_init { test_file_name } {
277254ba 3545 global gdb_wrapper_initialized
f6838f81 3546 global gdb_wrapper_target
0a6d0306 3547 global gdb_test_file_name
93f02886 3548 global cleanfiles
73c9764f 3549 global pf_prefix
277254ba 3550
93f02886
DJ
3551 set cleanfiles {}
3552
4ec70201 3553 gdb_clear_suppressed
c906108c 3554
73c9764f 3555 set gdb_test_file_name [file rootname [file tail $test_file_name]]
0a6d0306 3556
277254ba
MS
3557 # Make sure that the wrapper is rebuilt
3558 # with the appropriate multilib option.
f6838f81
DJ
3559 if { $gdb_wrapper_target != [current_target_name] } {
3560 set gdb_wrapper_initialized 0
3561 }
277254ba 3562
7b433602
JB
3563 # Unlike most tests, we have a small number of tests that generate
3564 # a very large amount of output. We therefore increase the expect
ff604a67
MR
3565 # buffer size to be able to contain the entire test output. This
3566 # is especially needed by gdb.base/info-macros.exp.
3567 match_max -d 65536
8d417781
PM
3568 # Also set this value for the currently running GDB.
3569 match_max [match_max -d]
c906108c
SS
3570
3571 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
73c9764f 3572 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
c906108c 3573
4ec70201 3574 global gdb_prompt
c906108c 3575 if [target_info exists gdb_prompt] {
4ec70201 3576 set gdb_prompt [target_info gdb_prompt]
c906108c
SS
3577 } else {
3578 set gdb_prompt "\\(gdb\\)"
3579 }
e11ac3a3
JK
3580 global use_gdb_stub
3581 if [info exists use_gdb_stub] {
3582 unset use_gdb_stub
3583 }
c906108c
SS
3584}
3585
0a6d0306 3586# Turn BASENAME into a full file name in the standard output
8a3e1f8d
TT
3587# directory. It is ok if BASENAME is the empty string; in this case
3588# the directory is returned.
0a6d0306
TT
3589
3590proc standard_output_file {basename} {
5e92f71a 3591 global objdir subdir gdb_test_file_name GDB_PARALLEL
0a6d0306 3592
5e92f71a
TT
3593 if {[info exists GDB_PARALLEL]} {
3594 set dir [file join $objdir outputs $subdir $gdb_test_file_name]
3595 file mkdir $dir
3596 return [file join $dir $basename]
3597 } else {
3598 return [file join $objdir $subdir $basename]
3599 }
0a6d0306
TT
3600}
3601
4e234898
TT
3602# Return the name of a file in our standard temporary directory.
3603
3604proc standard_temp_file {basename} {
5e92f71a
TT
3605 global objdir GDB_PARALLEL
3606
3607 if {[info exists GDB_PARALLEL]} {
3608 return [file join $objdir temp $basename]
3609 } else {
3610 return $basename
3611 }
4e234898
TT
3612}
3613
0a6d0306
TT
3614# Set 'testfile', 'srcfile', and 'binfile'.
3615#
3616# ARGS is a list of source file specifications.
3617# Without any arguments, the .exp file's base name is used to
3618# compute the source file name. The ".c" extension is added in this case.
3619# If ARGS is not empty, each entry is a source file specification.
3620# If the specification starts with a ".", it is treated as a suffix
3621# to append to the .exp file's base name.
3622# If the specification is the empty string, it is treated as if it
3623# were ".c".
3624# Otherwise it is a file name.
3625# The first file in the list is used to set the 'srcfile' global.
3626# Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
3627#
3628# Most tests should call this without arguments.
3629#
3630# If a completely different binary file name is needed, then it
3631# should be handled in the .exp file with a suitable comment.
3632
3633proc standard_testfile {args} {
3634 global gdb_test_file_name
93c0ef37 3635 global subdir
686f09d0 3636 global gdb_test_file_last_vars
0a6d0306
TT
3637
3638 # Outputs.
3639 global testfile binfile
3640
3641 set testfile $gdb_test_file_name
3642 set binfile [standard_output_file ${testfile}]
3643
3644 if {[llength $args] == 0} {
3645 set args .c
3646 }
3647
686f09d0
TT
3648 # Unset our previous output variables.
3649 # This can help catch hidden bugs.
3650 if {[info exists gdb_test_file_last_vars]} {
3651 foreach varname $gdb_test_file_last_vars {
3652 global $varname
3653 catch {unset $varname}
3654 }
3655 }
3656 # 'executable' is often set by tests.
3657 set gdb_test_file_last_vars {executable}
3658
0a6d0306
TT
3659 set suffix ""
3660 foreach arg $args {
3661 set varname srcfile$suffix
3662 global $varname
3663
3664 # Handle an extension.
3665 if {$arg == ""} {
3666 set arg $testfile.c
3667 } elseif {[string range $arg 0 0] == "."} {
3668 set arg $testfile$arg
3669 }
3670
3671 set $varname $arg
686f09d0 3672 lappend gdb_test_file_last_vars $varname
0a6d0306
TT
3673
3674 if {$suffix == ""} {
3675 set suffix 2
3676 } else {
3677 incr suffix
3678 }
3679 }
3680}
3681
7b356089
JB
3682# The default timeout used when testing GDB commands. We want to use
3683# the same timeout as the default dejagnu timeout, unless the user has
3684# already provided a specific value (probably through a site.exp file).
3685global gdb_test_timeout
3686if ![info exists gdb_test_timeout] {
3687 set gdb_test_timeout $timeout
3688}
3689
47050449
JB
3690# A list of global variables that GDB testcases should not use.
3691# We try to prevent their use by monitoring write accesses and raising
3692# an error when that happens.
3693set banned_variables { bug_id prms_id }
3694
abcc4978
PA
3695# A list of procedures that GDB testcases should not use.
3696# We try to prevent their use by monitoring invocations and raising
3697# an error when that happens.
3698set banned_procedures { strace }
3699
41b2c92d
PM
3700# gdb_init is called by runtest at start, but also by several
3701# tests directly; gdb_finish is only called from within runtest after
3702# each test source execution.
3703# Placing several traces by repetitive calls to gdb_init leads
3704# to problems, as only one trace is removed in gdb_finish.
3705# To overcome this possible problem, we add a variable that records
abcc4978
PA
3706# if the banned variables and procedures are already traced.
3707set banned_traced 0
41b2c92d 3708
73c9764f 3709proc gdb_init { test_file_name } {
7b356089
JB
3710 # Reset the timeout value to the default. This way, any testcase
3711 # that changes the timeout value without resetting it cannot affect
3712 # the timeout used in subsequent testcases.
3713 global gdb_test_timeout
3714 global timeout
3715 set timeout $gdb_test_timeout
3716
8b696e31
YQ
3717 if { [regexp ".*gdb\.reverse\/.*" $test_file_name]
3718 && [target_info exists gdb_reverse_timeout] } {
3719 set timeout [target_info gdb_reverse_timeout]
3720 }
3721
5e92f71a
TT
3722 # If GDB_INOTIFY is given, check for writes to '.'. This is a
3723 # debugging tool to help confirm that the test suite is
3724 # parallel-safe. You need "inotifywait" from the
3725 # inotify-tools package to use this.
3726 global GDB_INOTIFY inotify_pid
3727 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
3728 global outdir tool inotify_log_file
3729
3730 set exclusions {outputs temp gdb[.](log|sum) cache}
3731 set exclusion_re ([join $exclusions |])
3732
3733 set inotify_log_file [standard_temp_file inotify.out]
3734 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
3735 --exclude $exclusion_re \
3736 |& tee -a $outdir/$tool.log $inotify_log_file &]
3737
3738 # Wait for the watches; hopefully this is long enough.
3739 sleep 2
3740
3741 # Clear the log so that we don't emit a warning the first time
3742 # we check it.
3743 set fd [open $inotify_log_file w]
3744 close $fd
3745 }
3746
abcc4978
PA
3747 # Block writes to all banned variables, and invocation of all
3748 # banned procedures...
47050449 3749 global banned_variables
abcc4978
PA
3750 global banned_procedures
3751 global banned_traced
3752 if (!$banned_traced) {
41b2c92d
PM
3753 foreach banned_var $banned_variables {
3754 global "$banned_var"
3755 trace add variable "$banned_var" write error
3756 }
abcc4978
PA
3757 foreach banned_proc $banned_procedures {
3758 global "$banned_proc"
3759 trace add execution "$banned_proc" enter error
3760 }
3761 set banned_traced 1
47050449
JB
3762 }
3763
e7ab5e63
AB
3764 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
3765 # messages as expected.
c6f2ac43 3766 setenv LC_ALL C
e7ab5e63 3767 setenv LC_CTYPE C
c6f2ac43
PA
3768 setenv LANG C
3769
e7ab5e63
AB
3770 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
3771 # the test results. Even if /dev/null doesn't exist on the particular
3772 # platform, the readline library will use the default setting just by
3773 # failing to open the file. OTOH, opening /dev/null successfully will
3774 # also result in the default settings being used since nothing will be
3775 # read from this file.
3776 setenv INPUTRC "/dev/null"
3777
3778 # The gdb.base/readline.exp arrow key test relies on the standard VT100
3779 # bindings, so make sure that an appropriate terminal is selected.
3780 # The same bug doesn't show up if we use ^P / ^N instead.
3781 setenv TERM "vt100"
3782
3783 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
e4b8388f 3784 # grep. Clear GREP_OPTIONS to make the behavior predictable,
e7ab5e63
AB
3785 # especially having color output turned on can cause tests to fail.
3786 setenv GREP_OPTIONS ""
3787
03f2bd59
JK
3788 # Clear $gdbserver_reconnect_p.
3789 global gdbserver_reconnect_p
3790 set gdbserver_reconnect_p 1
3791 unset gdbserver_reconnect_p
3792
73c9764f 3793 return [default_gdb_init $test_file_name]
c906108c
SS
3794}
3795
3796proc gdb_finish { } {
a35cfb40
MR
3797 global gdbserver_reconnect_p
3798 global gdb_prompt
93f02886
DJ
3799 global cleanfiles
3800
a35cfb40 3801 # Give persistent gdbserver a chance to terminate before GDB is killed.
0b10be4f
JK
3802 if {[info exists gdbserver_reconnect_p] && $gdbserver_reconnect_p
3803 && [info exists gdb_spawn_id]} {
a35cfb40
MR
3804 send_gdb "kill\n";
3805 gdb_expect 10 {
3806 -re "y or n" {
3807 send_gdb "y\n";
3808 exp_continue;
3809 }
3810 -re "$gdb_prompt $" {
3811 }
3812 }
3813 }
3814
93f02886
DJ
3815 # Exit first, so that the files are no longer in use.
3816 gdb_exit
3817
3818 if { [llength $cleanfiles] > 0 } {
3819 eval remote_file target delete $cleanfiles
3820 set cleanfiles {}
3821 }
47050449
JB
3822
3823 # Unblock write access to the banned variables. Dejagnu typically
3824 # resets some of them between testcases.
3825 global banned_variables
abcc4978
PA
3826 global banned_procedures
3827 global banned_traced
3828 if ($banned_traced) {
41b2c92d
PM
3829 foreach banned_var $banned_variables {
3830 global "$banned_var"
3831 trace remove variable "$banned_var" write error
3832 }
abcc4978
PA
3833 foreach banned_proc $banned_procedures {
3834 global "$banned_proc"
3835 trace remove execution "$banned_proc" enter error
3836 }
3837 set banned_traced 0
47050449 3838 }
c906108c
SS
3839}
3840
3841global debug_format
7a292a7a 3842set debug_format "unknown"
c906108c
SS
3843
3844# Run the gdb command "info source" and extract the debugging format
3845# information from the output and save it in debug_format.
3846
3847proc get_debug_format { } {
3848 global gdb_prompt
3849 global verbose
3850 global expect_out
3851 global debug_format
3852
3853 set debug_format "unknown"
3854 send_gdb "info source\n"
3855 gdb_expect 10 {
919d772c 3856 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
c906108c
SS
3857 set debug_format $expect_out(1,string)
3858 verbose "debug format is $debug_format"
ae59b1da 3859 return 1
c906108c
SS
3860 }
3861 -re "No current source file.\r\n$gdb_prompt $" {
3862 perror "get_debug_format used when no current source file"
ae59b1da 3863 return 0
c906108c
SS
3864 }
3865 -re "$gdb_prompt $" {
3866 warning "couldn't check debug format (no valid response)."
ae59b1da 3867 return 1
c906108c
SS
3868 }
3869 timeout {
975531db 3870 warning "couldn't check debug format (timeout)."
ae59b1da 3871 return 1
c906108c
SS
3872 }
3873 }
3874}
3875
838ae6c4
JB
3876# Return true if FORMAT matches the debug format the current test was
3877# compiled with. FORMAT is a shell-style globbing pattern; it can use
3878# `*', `[...]', and so on.
3879#
3880# This function depends on variables set by `get_debug_format', above.
3881
3882proc test_debug_format {format} {
3883 global debug_format
3884
3885 return [expr [string match $format $debug_format] != 0]
3886}
3887
c906108c
SS
3888# Like setup_xfail, but takes the name of a debug format (DWARF 1,
3889# COFF, stabs, etc). If that format matches the format that the
3890# current test was compiled with, then the next test is expected to
3891# fail for any target. Returns 1 if the next test or set of tests is
3892# expected to fail, 0 otherwise (or if it is unknown). Must have
3893# previously called get_debug_format.
b55a4771 3894proc setup_xfail_format { format } {
4ec70201 3895 set ret [test_debug_format $format]
b55a4771 3896
838ae6c4 3897 if {$ret} then {
b55a4771
MS
3898 setup_xfail "*-*-*"
3899 }
ae59b1da 3900 return $ret
b55a4771 3901}
c906108c 3902
c6fee705
MC
3903# gdb_get_line_number TEXT [FILE]
3904#
3905# Search the source file FILE, and return the line number of the
0d7941a9 3906# first line containing TEXT. If no match is found, an error is thrown.
c6fee705
MC
3907#
3908# TEXT is a string literal, not a regular expression.
3909#
3910# The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
3911# specified, and does not start with "/", then it is assumed to be in
3912# "$srcdir/$subdir". This is awkward, and can be fixed in the future,
3913# by changing the callers and the interface at the same time.
3914# In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
3915# gdb.base/ena-dis-br.exp.
3916#
3917# Use this function to keep your test scripts independent of the
3918# exact line numbering of the source file. Don't write:
3919#
3920# send_gdb "break 20"
3921#
3922# This means that if anyone ever edits your test's source file,
3923# your test could break. Instead, put a comment like this on the
3924# source file line you want to break at:
3925#
3926# /* breakpoint spot: frotz.exp: test name */
3927#
3928# and then write, in your test script (which we assume is named
3929# frotz.exp):
3930#
3931# send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
3932#
3933# (Yes, Tcl knows how to handle the nested quotes and brackets.
3934# Try this:
3935# $ tclsh
3936# % puts "foo [lindex "bar baz" 1]"
3937# foo baz
3938# %
3939# Tcl is quite clever, for a little stringy language.)
3940#
3941# ===
3942#
3943# The previous implementation of this procedure used the gdb search command.
3944# This version is different:
3945#
3946# . It works with MI, and it also works when gdb is not running.
3947#
3948# . It operates on the build machine, not the host machine.
3949#
3950# . For now, this implementation fakes a current directory of
3951# $srcdir/$subdir to be compatible with the old implementation.
3952# This will go away eventually and some callers will need to
3953# be changed.
3954#
3955# . The TEXT argument is literal text and matches literally,
3956# not a regular expression as it was before.
3957#
3958# . State changes in gdb, such as changing the current file
3959# and setting $_, no longer happen.
3960#
3961# After a bit of time we can forget about the differences from the
3962# old implementation.
3963#
3964# --chastain 2004-08-05
3965
3966proc gdb_get_line_number { text { file "" } } {
3967 global srcdir
3968 global subdir
3969 global srcfile
c906108c 3970
c6fee705
MC
3971 if { "$file" == "" } then {
3972 set file "$srcfile"
3973 }
3974 if { ! [regexp "^/" "$file"] } then {
3975 set file "$srcdir/$subdir/$file"
c906108c
SS
3976 }
3977
c6fee705 3978 if { [ catch { set fd [open "$file"] } message ] } then {
0d7941a9 3979 error "$message"
c906108c 3980 }
c6fee705
MC
3981
3982 set found -1
3983 for { set line 1 } { 1 } { incr line } {
3984 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
0d7941a9 3985 error "$message"
c6fee705
MC
3986 }
3987 if { $nchar < 0 } then {
3988 break
3989 }
3990 if { [string first "$text" "$body"] >= 0 } then {
3991 set found $line
3992 break
3993 }
3994 }
3995
3996 if { [ catch { close "$fd" } message ] } then {
0d7941a9
KS
3997 error "$message"
3998 }
3999
4000 if {$found == -1} {
4001 error "undefined tag \"$text\""
c6fee705
MC
4002 }
4003
4004 return $found
c906108c
SS
4005}
4006
b477a5e6
PA
4007# Continue the program until it ends.
4008#
fda326dd
TT
4009# MSSG is the error message that gets printed. If not given, a
4010# default is used.
4011# COMMAND is the command to invoke. If not given, "continue" is
4012# used.
eceb0c5f
TT
4013# ALLOW_EXTRA is a flag indicating whether the test should expect
4014# extra output between the "Continuing." line and the program
4015# exiting. By default it is zero; if nonzero, any extra output
4016# is accepted.
fda326dd 4017
eceb0c5f 4018proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
e11ac3a3 4019 global inferior_exited_re use_gdb_stub
7a292a7a 4020
fda326dd
TT
4021 if {$mssg == ""} {
4022 set text "continue until exit"
4023 } else {
4024 set text "continue until exit at $mssg"
4025 }
eceb0c5f
TT
4026 if {$allow_extra} {
4027 set extra ".*"
4028 } else {
4029 set extra ""
4030 }
b477a5e6
PA
4031
4032 # By default, we don't rely on exit() behavior of remote stubs --
4033 # it's common for exit() to be implemented as a simple infinite
4034 # loop, or a forced crash/reset. For native targets, by default, we
4035 # assume process exit is reported as such. If a non-reliable target
4036 # is used, we set a breakpoint at exit, and continue to that.
4037 if { [target_info exists exit_is_reliable] } {
4038 set exit_is_reliable [target_info exit_is_reliable]
4039 } else {
4040 set exit_is_reliable [expr ! $use_gdb_stub]
4041 }
4042
4043 if { ! $exit_is_reliable } {
7a292a7a
SS
4044 if {![gdb_breakpoint "exit"]} {
4045 return 0
4046 }
eceb0c5f 4047 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
fda326dd 4048 $text
7a292a7a
SS
4049 } else {
4050 # Continue until we exit. Should not stop again.
4051 # Don't bother to check the output of the program, that may be
4052 # extremely tough for some remote systems.
eceb0c5f
TT
4053 gdb_test $command \
4054 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
fda326dd 4055 $text
7a292a7a
SS
4056 }
4057}
4058
4059proc rerun_to_main {} {
e11ac3a3 4060 global gdb_prompt use_gdb_stub
7a292a7a 4061
e11ac3a3 4062 if $use_gdb_stub {
7a292a7a
SS
4063 gdb_run_cmd
4064 gdb_expect {
4065 -re ".*Breakpoint .*main .*$gdb_prompt $"\
4066 {pass "rerun to main" ; return 0}
4067 -re "$gdb_prompt $"\
4068 {fail "rerun to main" ; return 0}
4069 timeout {fail "(timeout) rerun to main" ; return 0}
4070 }
4071 } else {
4072 send_gdb "run\n"
4073 gdb_expect {
11350d2a
CV
4074 -re "The program .* has been started already.*y or n. $" {
4075 send_gdb "y\n"
4076 exp_continue
4077 }
7a292a7a
SS
4078 -re "Starting program.*$gdb_prompt $"\
4079 {pass "rerun to main" ; return 0}
4080 -re "$gdb_prompt $"\
4081 {fail "rerun to main" ; return 0}
4082 timeout {fail "(timeout) rerun to main" ; return 0}
4083 }
4084 }
4085}
c906108c 4086
13a5e3b8
MS
4087# Print a message and return true if a test should be skipped
4088# due to lack of floating point suport.
4089
4090proc gdb_skip_float_test { msg } {
4091 if [target_info exists gdb,skip_float_tests] {
4ec70201 4092 verbose "Skipping test '$msg': no float tests."
ae59b1da 4093 return 1
13a5e3b8 4094 }
ae59b1da 4095 return 0
13a5e3b8
MS
4096}
4097
4098# Print a message and return true if a test should be skipped
4099# due to lack of stdio support.
4100
4101proc gdb_skip_stdio_test { msg } {
4102 if [target_info exists gdb,noinferiorio] {
4ec70201 4103 verbose "Skipping test '$msg': no inferior i/o."
ae59b1da 4104 return 1
13a5e3b8 4105 }
ae59b1da 4106 return 0
13a5e3b8
MS
4107}
4108
4109proc gdb_skip_bogus_test { msg } {
ae59b1da 4110 return 0
13a5e3b8
MS
4111}
4112
e515b470
DJ
4113# Return true if a test should be skipped due to lack of XML support
4114# in the host GDB.
d0ef5df8 4115# NOTE: This must be called while gdb is *not* running.
e515b470 4116
17e1c970 4117gdb_caching_proc gdb_skip_xml_test {
e515b470
DJ
4118 global gdb_prompt
4119 global srcdir
e515b470
DJ
4120
4121 gdb_start
17e1c970 4122 set xml_missing 0
e515b470
DJ
4123 gdb_test_multiple "set tdesc filename ${srcdir}/gdb.xml/trivial.xml" "" {
4124 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
17e1c970 4125 set xml_missing 1
e515b470
DJ
4126 }
4127 -re ".*$gdb_prompt $" { }
4128 }
4129 gdb_exit
17e1c970 4130 return $xml_missing
e515b470 4131}
1f8a6abb
EZ
4132
4133# Note: the procedure gdb_gnu_strip_debug will produce an executable called
4134# ${binfile}.dbglnk, which is just like the executable ($binfile) but without
4135# the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
8e1d0c49
JK
4136# the name of a debuginfo only file. This file will be stored in the same
4137# subdirectory.
1f8a6abb
EZ
4138
4139# Functions for separate debug info testing
4140
4141# starting with an executable:
4142# foo --> original executable
4143
4144# at the end of the process we have:
4145# foo.stripped --> foo w/o debug info
8e1d0c49 4146# foo.debug --> foo's debug info
1f8a6abb
EZ
4147# foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
4148
4935890f
JK
4149# Return the build-id hex string (usually 160 bits as 40 hex characters)
4150# converted to the form: .build-id/ab/cdef1234...89.debug
4151# Return "" if no build-id found.
4152proc build_id_debug_filename_get { exec } {
53e981d9 4153 set tmp [standard_output_file "${exec}-tmp"]
4fa7d390 4154 set objcopy_program [gdb_find_objcopy]
8b3fc8d8
MK
4155
4156 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $exec $tmp" output]
4157 verbose "result is $result"
4158 verbose "output is $output"
4159 if {$result == 1} {
4160 return ""
4161 }
4935890f 4162 set fi [open $tmp]
b7fca990 4163 fconfigure $fi -translation binary
4935890f
JK
4164 # Skip the NOTE header.
4165 read $fi 16
4166 set data [read $fi]
4167 close $fi
4168 file delete $tmp
7020f05c 4169 if ![string compare $data ""] then {
4935890f
JK
4170 return ""
4171 }
4172 # Convert it to hex.
4173 binary scan $data H* data
061b5285 4174 regsub {^..} $data {\0/} data
ae59b1da 4175 return ".build-id/${data}.debug"
4935890f
JK
4176}
4177
94277a38
DJ
4178# Create stripped files for DEST, replacing it. If ARGS is passed, it is a
4179# list of optional flags. The only currently supported flag is no-main,
4180# which removes the symbol entry for main from the separate debug file.
c0201579
JK
4181#
4182# Function returns zero on success. Function will return non-zero failure code
4183# on some targets not supporting separate debug info (such as i386-msdos).
1f8a6abb 4184
94277a38
DJ
4185proc gdb_gnu_strip_debug { dest args } {
4186
8e1d0c49
JK
4187 # Use the first separate debug info file location searched by GDB so the
4188 # run cannot be broken by some stale file searched with higher precedence.
4189 set debug_file "${dest}.debug"
4190
b741e217 4191 set strip_to_file_program [transform strip]
4fa7d390 4192 set objcopy_program [gdb_find_objcopy]
1f8a6abb 4193
1f8a6abb
EZ
4194 set debug_link [file tail $debug_file]
4195 set stripped_file "${dest}.stripped"
4196
4197 # Get rid of the debug info, and store result in stripped_file
4198 # something like gdb/testsuite/gdb.base/blah.stripped.
4199 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
4200 verbose "result is $result"
4201 verbose "output is $output"
4202 if {$result == 1} {
4203 return 1
4204 }
4205
d521f563
JK
4206 # Workaround PR binutils/10802:
4207 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4208 set perm [file attributes ${dest} -permissions]
4209 file attributes ${stripped_file} -permissions $perm
4210
1f8a6abb
EZ
4211 # Get rid of everything but the debug info, and store result in debug_file
4212 # This will be in the .debug subdirectory, see above.
4213 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
4214 verbose "result is $result"
4215 verbose "output is $output"
4216 if {$result == 1} {
4217 return 1
4218 }
4219
94277a38
DJ
4220 # If no-main is passed, strip the symbol for main from the separate
4221 # file. This is to simulate the behavior of elfutils's eu-strip, which
4222 # leaves the symtab in the original file only. There's no way to get
4223 # objcopy or strip to remove the symbol table without also removing the
4224 # debugging sections, so this is as close as we can get.
4225 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
4226 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
4227 verbose "result is $result"
4228 verbose "output is $output"
4229 if {$result == 1} {
4230 return 1
4231 }
4232 file delete "${debug_file}"
4233 file rename "${debug_file}-tmp" "${debug_file}"
4234 }
4235
1f8a6abb
EZ
4236 # Link the two previous output files together, adding the .gnu_debuglink
4237 # section to the stripped_file, containing a pointer to the debug_file,
4238 # save the new file in dest.
4239 # This will be the regular executable filename, in the usual location.
4240 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
4241 verbose "result is $result"
4242 verbose "output is $output"
4243 if {$result == 1} {
4244 return 1
4245 }
4246
d521f563
JK
4247 # Workaround PR binutils/10802:
4248 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4249 set perm [file attributes ${stripped_file} -permissions]
4250 file attributes ${dest} -permissions $perm
4251
4252 return 0
1f8a6abb
EZ
4253}
4254
d8295fe9
VP
4255# Test the output of GDB_COMMAND matches the pattern obtained
4256# by concatenating all elements of EXPECTED_LINES. This makes
4257# it possible to split otherwise very long string into pieces.
4258# If third argument is not empty, it's used as the name of the
4259# test to be printed on pass/fail.
4260proc help_test_raw { gdb_command expected_lines args } {
4261 set message $gdb_command
4262 if [llength $args]>0 then {
4263 set message [lindex $args 0]
4264 }
4265 set expected_output [join $expected_lines ""]
4266 gdb_test "${gdb_command}" "${expected_output}" $message
4267}
4268
6aee0d90 4269# Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
d8295fe9
VP
4270# are regular expressions that should match the beginning of output,
4271# before the list of commands in that class. The presence of
4272# command list and standard epilogue will be tested automatically.
4273proc test_class_help { command_class expected_initial_lines args } {
4274 set l_stock_body {
4275 "List of commands\:.*\[\r\n\]+"
4276 "Type \"help\" followed by command name for full documentation\.\[\r\n\]+"
4277 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+"
4278 "Command name abbreviations are allowed if unambiguous\."
4279 }
4280 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4281
4282 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
4283}
4284
4285# COMMAND_LIST should have either one element -- command to test, or
4286# two elements -- abbreviated command to test, and full command the first
4287# element is abbreviation of.
4288# The command must be a prefix command. EXPECTED_INITIAL_LINES
4289# are regular expressions that should match the beginning of output,
4290# before the list of subcommands. The presence of
4291# subcommand list and standard epilogue will be tested automatically.
4292proc test_prefix_command_help { command_list expected_initial_lines args } {
4293 set command [lindex $command_list 0]
4294 if {[llength $command_list]>1} {
4295 set full_command [lindex $command_list 1]
4296 } else {
4297 set full_command $command
4298 }
4299 # Use 'list' and not just {} because we want variables to
4300 # be expanded in this list.
4301 set l_stock_body [list\
4302 "List of $full_command subcommands\:.*\[\r\n\]+"\
4303 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
4304 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
4305 "Command name abbreviations are allowed if unambiguous\."]
4306 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4307 if {[llength $args]>0} {
4308 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
4309 } else {
4310 help_test_raw "help ${command}" $l_entire_body
4311 }
4312}
dbc52822 4313
85b4440a
TT
4314# Build executable named EXECUTABLE from specifications that allow
4315# different options to be passed to different sub-compilations.
4316# TESTNAME is the name of the test; this is passed to 'untested' if
4317# something fails.
a0d3f2f5
SCR
4318# OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
4319# contains the option "pthreads", then gdb_compile_pthreads is used.
85b4440a
TT
4320# ARGS is a flat list of source specifications, of the form:
4321# { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
4322# Each SOURCE is compiled to an object file using its OPTIONS,
4323# using gdb_compile.
4324# Returns 0 on success, -1 on failure.
4325proc build_executable_from_specs {testname executable options args} {
dbc52822
VP
4326 global subdir
4327 global srcdir
dbc52822 4328
0a6d0306 4329 set binfile [standard_output_file $executable]
dbc52822 4330
fd961404
DE
4331 set info_options ""
4332 if { [lsearch -exact $options "c++"] >= 0 } {
4333 set info_options "c++"
4334 }
4c93b1db 4335 if [get_compiler_info ${info_options}] {
dbc52822
VP
4336 return -1
4337 }
a29a3fb7 4338
a29a3fb7
GB
4339 set func gdb_compile
4340 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
4341 if {$func_index != -1} {
4342 set func "${func}_[lindex $options $func_index]"
4343 }
4344
4345 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
4346 # parameter. They also requires $sources while gdb_compile and
4347 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
4348 if [string match gdb_compile_shlib* $func] {
4349 set sources_path {}
4350 foreach {s local_options} $args {
0e5c4555
AA
4351 if { [regexp "^/" "$s"] } then {
4352 lappend sources_path "$s"
4353 } else {
4354 lappend sources_path "$srcdir/$subdir/$s"
4355 }
a29a3fb7
GB
4356 }
4357 set ret [$func $sources_path "${binfile}" $options]
4358 } else {
4359 set objects {}
4360 set i 0
4361 foreach {s local_options} $args {
0e5c4555
AA
4362 if { ! [regexp "^/" "$s"] } then {
4363 set s "$srcdir/$subdir/$s"
4364 }
4365 if { [gdb_compile "${s}" "${binfile}${i}.o" object $local_options] != "" } {
a29a3fb7
GB
4366 untested $testname
4367 return -1
4368 }
4369 lappend objects "${binfile}${i}.o"
4370 incr i
4371 }
4372 set ret [$func $objects "${binfile}" executable $options]
4373 }
4374 if { $ret != "" } {
4375 untested $testname
4376 return -1
4377 }
4378
dbc52822
VP
4379 return 0
4380}
4381
85b4440a
TT
4382# Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
4383# provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
4384# to pass to untested, if something is wrong. OPTIONS are passed
4385# to gdb_compile directly.
4386proc build_executable { testname executable {sources ""} {options {debug}} } {
4387 if {[llength $sources]==0} {
4388 set sources ${executable}.c
4389 }
4390
4391 set arglist [list $testname $executable $options]
4392 foreach source $sources {
4393 lappend arglist $source $options
4394 }
4395
4396 return [eval build_executable_from_specs $arglist]
4397}
4398
dbc52822 4399# Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
0a6d0306 4400# the basename of the binary.
dbc52822
VP
4401proc clean_restart { executable } {
4402 global srcdir
dbc52822 4403 global subdir
0a6d0306 4404 set binfile [standard_output_file ${executable}]
dbc52822
VP
4405
4406 gdb_exit
4407 gdb_start
4408 gdb_reinitialize_dir $srcdir/$subdir
4409 gdb_load ${binfile}
dbc52822
VP
4410}
4411
85b4440a
TT
4412# Prepares for testing by calling build_executable_full, then
4413# clean_restart.
4414# TESTNAME is the name of the test.
4415# Each element in ARGS is a list of the form
4416# { EXECUTABLE OPTIONS SOURCE_SPEC... }
4417# These are passed to build_executable_from_specs, which see.
4418# The last EXECUTABLE is passed to clean_restart.
4419# Returns 0 on success, non-zero on failure.
4420proc prepare_for_testing_full {testname args} {
4421 foreach spec $args {
4422 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
4423 return -1
4424 }
4425 set executable [lindex $spec 0]
4426 }
4427 clean_restart $executable
4428 return 0
4429}
4430
dbc52822
VP
4431# Prepares for testing, by calling build_executable, and then clean_restart.
4432# Please refer to build_executable for parameter description.
4433proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
4434
734a5c36 4435 if {[build_executable $testname $executable $sources $options] == -1} {
dbc52822
VP
4436 return -1
4437 }
4438 clean_restart $executable
4439
4440 return 0
4441}
7065b901
TT
4442
4443proc get_valueof { fmt exp default } {
4444 global gdb_prompt
4445
4446 set test "get valueof \"${exp}\""
4447 set val ${default}
4448 gdb_test_multiple "print${fmt} ${exp}" "$test" {
417e16e2
PM
4449 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
4450 set val $expect_out(1,string)
4451 pass "$test ($val)"
4452 }
4453 timeout {
4454 fail "$test (timeout)"
4455 }
4456 }
4457 return ${val}
4458}
4459
4460proc get_integer_valueof { exp default } {
4461 global gdb_prompt
4462
4463 set test "get integer valueof \"${exp}\""
4464 set val ${default}
4465 gdb_test_multiple "print /d ${exp}" "$test" {
7065b901
TT
4466 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
4467 set val $expect_out(1,string)
4468 pass "$test ($val)"
4469 }
4470 timeout {
417e16e2 4471 fail "$test (timeout)"
7065b901
TT
4472 }
4473 }
4474 return ${val}
4475}
4476
faafb047
PM
4477proc get_hexadecimal_valueof { exp default } {
4478 global gdb_prompt
4479 send_gdb "print /x ${exp}\n"
4480 set test "get hexadecimal valueof \"${exp}\""
4481 gdb_expect {
4482 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
4483 set val $expect_out(1,string)
4484 pass "$test"
4485 }
4486 timeout {
4487 set val ${default}
4488 fail "$test (timeout)"
4489 }
4490 }
4491 return ${val}
4492}
417e16e2 4493
7065b901 4494proc get_sizeof { type default } {
417e16e2 4495 return [get_integer_valueof "sizeof (${type})" $default]
7065b901
TT
4496}
4497
ed3ef339
DE
4498proc get_target_charset { } {
4499 global gdb_prompt
4500
4501 gdb_test_multiple "show target-charset" "" {
4502 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
4503 return $expect_out(1,string)
4504 }
4505 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
4506 return $expect_out(1,string)
4507 }
4508 }
4509
4510 # Pick a reasonable default.
4511 warning "Unable to read target-charset."
4512 return "UTF-8"
4513}
4514
db863c42
MF
4515# Get the current value for remotetimeout and return it.
4516proc get_remotetimeout { } {
4517 global gdb_prompt
4518 global decimal
4519
4520 gdb_test_multiple "show remotetimeout" "" {
4521 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
ae59b1da 4522 return $expect_out(1,string)
db863c42
MF
4523 }
4524 }
4525
4526 # Pick the default that gdb uses
4527 warning "Unable to read remotetimeout"
4528 return 300
4529}
4530
4531# Set the remotetimeout to the specified timeout. Nothing is returned.
4532proc set_remotetimeout { timeout } {
4533 global gdb_prompt
4534
4535 gdb_test_multiple "set remotetimeout $timeout" "" {
4536 -re "$gdb_prompt $" {
4537 verbose "Set remotetimeout to $timeout\n"
4538 }
4539 }
4540}
4541
1e537771
TT
4542# ROOT and FULL are file names. Returns the relative path from ROOT
4543# to FULL. Note that FULL must be in a subdirectory of ROOT.
4544# For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
4545# will return "ls".
4546
4547proc relative_filename {root full} {
4548 set root_split [file split $root]
4549 set full_split [file split $full]
4550
4551 set len [llength $root_split]
4552
4553 if {[eval file join $root_split]
4554 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
4555 error "$full not a subdir of $root"
4556 }
4557
4558 return [eval file join [lrange $full_split $len end]]
4559}
4560
812f7342
TT
4561# Log gdb command line and script if requested.
4562if {[info exists TRANSCRIPT]} {
4563 rename send_gdb real_send_gdb
4564 rename remote_spawn real_remote_spawn
4565 rename remote_close real_remote_close
4566
4567 global gdb_transcript
4568 set gdb_transcript ""
4569
4570 global gdb_trans_count
4571 set gdb_trans_count 1
4572
4573 proc remote_spawn {args} {
4574 global gdb_transcript gdb_trans_count outdir
4575
4576 if {$gdb_transcript != ""} {
4577 close $gdb_transcript
4578 }
4579 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
4580 puts $gdb_transcript [lindex $args 1]
4581 incr gdb_trans_count
4582
4583 return [uplevel real_remote_spawn $args]
4584 }
4585
4586 proc remote_close {args} {
4587 global gdb_transcript
4588
4589 if {$gdb_transcript != ""} {
4590 close $gdb_transcript
4591 set gdb_transcript ""
4592 }
4593
4594 return [uplevel real_remote_close $args]
4595 }
4596
4597 proc send_gdb {args} {
4598 global gdb_transcript
4599
4600 if {$gdb_transcript != ""} {
4601 puts -nonewline $gdb_transcript [lindex $args 0]
4602 }
4603
4604 return [uplevel real_send_gdb $args]
4605 }
4606}
37aeb5df 4607
5e92f71a
TT
4608# If GDB_PARALLEL exists, then set up the parallel-mode directories.
4609if {[info exists GDB_PARALLEL]} {
4610 if {[is_remote host]} {
4611 unset GDB_PARALLEL
4612 } else {
4613 file mkdir outputs temp cache
4614 }
4615}
4616
bbfba9ed 4617proc core_find {binfile {deletefiles {}} {arg ""}} {
37aeb5df
JK
4618 global objdir subdir
4619
4620 set destcore "$binfile.core"
4621 file delete $destcore
4622
4623 # Create a core file named "$destcore" rather than just "core", to
4624 # avoid problems with sys admin types that like to regularly prune all
4625 # files named "core" from the system.
4626 #
4627 # Arbitrarily try setting the core size limit to "unlimited" since
4628 # this does not hurt on systems where the command does not work and
4629 # allows us to generate a core on systems where it does.
4630 #
4631 # Some systems append "core" to the name of the program; others append
4632 # the name of the program to "core"; still others (like Linux, as of
4633 # May 2003) create cores named "core.PID". In the latter case, we
4634 # could have many core files lying around, and it may be difficult to
4635 # tell which one is ours, so let's run the program in a subdirectory.
4636 set found 0
93c0ef37 4637 set coredir [standard_output_file coredir.[getpid]]
37aeb5df 4638 file mkdir $coredir
bbfba9ed 4639 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
37aeb5df
JK
4640 # remote_exec host "${binfile}"
4641 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
4642 if [remote_file build exists $i] {
4643 remote_exec build "mv $i $destcore"
4644 set found 1
4645 }
4646 }
4647 # Check for "core.PID".
4648 if { $found == 0 } {
4649 set names [glob -nocomplain -directory $coredir core.*]
4650 if {[llength $names] == 1} {
4651 set corefile [file join $coredir [lindex $names 0]]
4652 remote_exec build "mv $corefile $destcore"
4653 set found 1
4654 }
4655 }
4656 if { $found == 0 } {
4657 # The braindamaged HPUX shell quits after the ulimit -c above
4658 # without executing ${binfile}. So we try again without the
4659 # ulimit here if we didn't find a core file above.
4660 # Oh, I should mention that any "braindamaged" non-Unix system has
4661 # the same problem. I like the cd bit too, it's really neat'n stuff.
4662 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
4663 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
4664 if [remote_file build exists $i] {
4665 remote_exec build "mv $i $destcore"
4666 set found 1
4667 }
4668 }
4669 }
4670
4671 # Try to clean up after ourselves.
4672 foreach deletefile $deletefiles {
4673 remote_file build delete [file join $coredir $deletefile]
4674 }
4675 remote_exec build "rmdir $coredir"
4676
4677 if { $found == 0 } {
4678 warning "can't generate a core file - core tests suppressed - check ulimit -c"
4679 return ""
4680 }
4681 return $destcore
4682}
ee5683ab
PM
4683
4684# gdb_target_symbol_prefix_flags returns a string that can be added
4685# to gdb_compile options to define SYMBOL_PREFIX macro value
4686# symbol_prefix_flags returns a string that can be added
4687# for targets that use underscore as symbol prefix.
4688# TODO: find out automatically if the target needs this.
4689
4690proc gdb_target_symbol_prefix_flags {} {
4691 if { [istarget "*-*-cygwin*"] || [istarget "i?86-*-mingw*"]
4692 || [istarget "*-*-msdosdjgpp*"] || [istarget "*-*-go32*"] } {
4693 return "additional_flags=-DSYMBOL_PREFIX=\"_\""
4694 } else {
4695 return ""
4696 }
4697}
4698
6e45f158
DE
4699# A wrapper for 'remote_exec host' that passes or fails a test.
4700# Returns 0 if all went well, nonzero on failure.
4701# TEST is the name of the test, other arguments are as for remote_exec.
4702
4703proc run_on_host { test program args } {
4704 verbose -log "run_on_host: $program $args"
4705 # remote_exec doesn't work properly if the output is set but the
4706 # input is the empty string -- so replace an empty input with
4707 # /dev/null.
4708 if {[llength $args] > 1 && [lindex $args 1] == ""} {
4709 set args [lreplace $args 1 1 "/dev/null"]
4710 }
4711 set result [eval remote_exec host [list $program] $args]
4712 verbose "result is $result"
4713 set status [lindex $result 0]
4714 set output [lindex $result 1]
4715 if {$status == 0} {
4716 pass $test
4717 return 0
4718 } else {
50cc37c8 4719 verbose -log "run_on_host failed: $output"
6e45f158
DE
4720 fail $test
4721 return -1
4722 }
4723}
4724
a587b477
DE
4725# Return non-zero if "board_info debug_flags" mentions Fission.
4726# http://gcc.gnu.org/wiki/DebugFission
4727# Fission doesn't support everything yet.
4728# This supports working around bug 15954.
4729
4730proc using_fission { } {
4731 set debug_flags [board_info [target_info name] debug_flags]
4732 return [regexp -- "-gsplit-dwarf" $debug_flags]
4733}
4734
4b48d439
KS
4735# Search the caller's ARGS list and set variables according to the list of
4736# valid options described by ARGSET.
4737#
4738# The first member of each one- or two-element list in ARGSET defines the
4739# name of a variable that will be added to the caller's scope.
4740#
4741# If only one element is given to describe an option, it the value is
4742# 0 if the option is not present in (the caller's) ARGS or 1 if
4743# it is.
4744#
4745# If two elements are given, the second element is the default value of
4746# the variable. This is then overwritten if the option exists in ARGS.
4747#
4748# Any parse_args elements in (the caller's) ARGS will be removed, leaving
4749# any optional components.
4750
4751# Example:
4752# proc myproc {foo args} {
4753# parse_args {{bar} {baz "abc"} {qux}}
4754# # ...
4755# }
4756# myproc ABC -bar -baz DEF peanut butter
4757# will define the following variables in myproc:
4758# foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
4759# args will be the list {peanut butter}
4760
4761proc parse_args { argset } {
4762 upvar args args
4763
4764 foreach argument $argset {
4765 if {[llength $argument] == 1} {
4766 # No default specified, so we assume that we should set
4767 # the value to 1 if the arg is present and 0 if it's not.
4768 # It is assumed that no value is given with the argument.
4769 set result [lsearch -exact $args "-$argument"]
4770 if {$result != -1} then {
4771 uplevel 1 [list set $argument 1]
4772 set args [lreplace $args $result $result]
4773 } else {
4774 uplevel 1 [list set $argument 0]
4775 }
4776 } elseif {[llength $argument] == 2} {
4777 # There are two items in the argument. The second is a
4778 # default value to use if the item is not present.
4779 # Otherwise, the variable is set to whatever is provided
4780 # after the item in the args.
4781 set arg [lindex $argument 0]
4782 set result [lsearch -exact $args "-[lindex $arg 0]"]
4783 if {$result != -1} then {
4784 uplevel 1 [list set $arg [lindex $args [expr $result+1]]]
4785 set args [lreplace $args $result [expr $result+1]]
4786 } else {
4787 uplevel 1 [list set $arg [lindex $argument 1]]
4788 }
4789 } else {
4790 error "Badly formatted argument \"$argument\" in argument set"
4791 }
4792 }
4793
4794 # The remaining args should be checked to see that they match the
4795 # number of items expected to be passed into the procedure...
4796}
4797
e9089e05
MM
4798# Capture the output of COMMAND in a string ignoring PREFIX; return that string.
4799proc capture_command_output { command prefix } {
4800 global gdb_prompt
4801 global expect_out
4802
4803 set output_string ""
4804 gdb_test_multiple "$command" "capture_command_output for $command" {
4805 -re "${command}\[\r\n\]+${prefix}(.*)\[\r\n\]+$gdb_prompt $" {
4806 set output_string $expect_out(1,string)
4807 }
4808 }
4809 return $output_string
4810}
4811
42159ca5
TT
4812# Always load compatibility stuff.
4813load_lib future.exp
This page took 1.823481 seconds and 4 git commands to generate.